API Documentation Change Log

This document contains a running record of changes made to the API documentation.

Currently there is one supported version of the Cybereason API. Most the APIs and API endpoints are supported for all supported Cybereason versions, unless otherwise noted.

Date	Change	Relevant Documentation	Relevant Versions
September 2021	Update Query API documentation for better usability and clarity.	How to Build Queries	All
August 2021	Add tutorial topics.	API Tutorials	All
July 2021	Updated Elements and Features to align with platform MITRE tags.	Query Elements and Features	19.2 and later
June 2021	Add a topic on how to log in with the API using two-factor authentication (TFA).	Log in with the API and TFA	All
April 2021	Add API reference topics for Incident Response API.	Manage Incident Response Tools	21.1 and later
April 2021	Added the Detection Event Element to the list of Elements and Features.	Query Elements and Features	20.1 and later
October 2020	Added relevant Elements and Features for Cybereason Mobile	Query Elements and Features	20.1 and later
August 2020	Updated Elements and Features descriptions for clarity on what the detection or data collection the Feature represents.	Query Elements and Features	All
July/August 2020	Added a number of use-case scenarios, including: Retrieve a list of Malops for a specific time period Retrieve a list of suspicions and evidence present in your environment Add sensor tags to machines involved in Malops Download sensor logs	Get a List of Suspicions or Evidence Get a Report of Malops and Suspicions for a Specific Time Period Add Sensor Tags to a Machine Associated with a Malop Download Sensor Logs Automatically remediate Malops	All
July 2020	Add additional advanced conceptual topics on how to use the API, including: Parsing JSON responses Automation and the API	Extract Data from a Response Automating your Workflow	All
April 2020	Added a section to each API reference topic for important response fields	All reference topics	All
March 2020	Added custom rules API	Add Custom Detection Rules
March 2020	Adding reference API topics for Malops Management screen	Respond to Malops	20.1.43 and later
February 2020	Clarification on templateContext field in query API request	Customize Query Response Fields	All
January 2020	Adding topic for permissions required for endpoints	Required Permissions	All
December 2019	Changed formatting of Python examples to use variables and incorporate login information into script.	N/A	All
October 2019	Added additional topic with links to download the script for any example.	API Example Scripts	All
September 2019	Added links inline in every topic to download a file with the request bodies for each request or example.	N/A	All
August 2019	Added a topic on how to use the API documention with a number of tips and tricks.	Tips for Using the API Documentation	All
July 2019	Added additional examples to the API.	N/A	All
July 2019	Added an additional API type for how to query global threat intelligence information.	Get Threat Intel	All
June 2019	Added Getting Started content and additional step-by-step examples to help users quickly benefit from the API.	Common Use Case Examples
May 2019	Added additional query examples.	Query Examples	All
April 2019	Added Remedation API with reference topics on how to use the API for remediation.	Remediate Items Get Remediation Status Check Remediation Progress Abort a Remediation Operation	All
April 2019	Added topic detailing the permissions required to run each individual API request.	Permission	All
March 2019	Added topic to discuss how to use the API for integration with other platforms	Integration	All
February 2019	API reference page design change - all sections made into dropdown expandable sections	N/A	All
February 2019	Moved documentation on Query API to appendix section	How to Build Queries	All
November 2018	Added additional APIs to Malop API Reference section, including Update Malop Status and Add Malop Comment.	Add Malop Comment Update Malop Status	All
December 2018	Added Malware APIs to query Malware details.	Add Malop Comment Update Malop Status	17.5 and later
October 2018	Added topics for common-use cases, including more in-depth examples on how to use the API for real-world situations.	Common Uses	All
September 2018	Added Python syntax for all examples.	N/A	All
September 2018	Created newer version of documentation with conceptual information on API including: How the API uses REST basics Information on requests and responses How the API uses the URI convention	REST Basics requests Responses	All
August 2018	Adding API endpoints for Sensor tagging	Get Sensor Tags Create Sensor Tags Update Sensor Tags Delete Sensor Tags	18.0 and later
August 2018	Reference page redesign, including: Separate headers for each item contained in the response Separation of request and response information Separation of response success and response failure information	N/A	All