API and Schema Migration
Overview
As Carbon Black Cloud develops new functionality, new APIs are needed. This leads to the deprecation and eventual deactivation of older APIs.
In this document, you will find:
- The Migration Summary table, including step-by-step migration guides to help you seamlessly transition
- New Features that will be unlocked when you migrate
- A Migration Checklist with common migration tasks
- Resources for additional support
Migration Summary
Access Level Deactivation
After the APIs above have been deactivated, the legacy Access Level types of API, LIVE_RESPONSE and SIEM will not be required
and they will also be deactivated. All supported APIs will use the Access Level type Custom with fine grained permission controls.
| Access Level Type | All dependent APIs will be deactivated by | Targeted API Key Deactivation Date |
|---|---|---|
| API | July 31, 2024 | October 31, 2024 |
| LIVE_RESPONSE | July 31, 2024 | October 31, 2024 |
| SIEM | October 31, 2024 | January 31, 2025 |
New Features
Migrating to the latest APIs and Schemas will unlock several new features including:
- Fine-grained access control for Live Response means you can limit the API key to only the specific operations that should be performed
- Policies now include the ability to turn data collection for auth events and XDR data on or off and configure Host Based Firewall rules - more policy settings are in the works
- Getting all details about an alert, such as process command line, in the alert record - no need to make follow-up calls to search for the process details
- Data schema consistency across the Alert v7 API and Data Forwarder Alert v2 schema - same fields and same field names
Migration Checklist
- Check the migration guides to determine if you need to update your authentication.
- Find out which endpoints your organization uses, and utilize the migration guides to find the equivalent endpoints in the new APIs.
- View the schema mapping tables in the migration guides to verify any field changes and ensure you are taking advantage of newly added fields.
- Update your app’s code to use the latest version of the API or Schema.
Support and Resources
- Use the Developer Community Forum to discuss issues and get answers from other API developers in the Carbon Black Community.
- Report bugs and change requests to Carbon Black Support.
- View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.
Give Feedback
Use this form to give us feedback about this site or any of the documentation.
Last modified on September 20, 2023