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
APIs to be deactivated on July 31st 2024.
APIs to be deactivated on October 31st 2024:
| Migration Guide | Deprecated API | Replacement API | Deprecated Date | Targeted Deactivation Date |
|---|---|---|---|---|
| Audit Log Access Level Migration | Use of API Access Level Type |
Use of Custom Access Level Type |
June 2023 | October 31, 2024 |
| Notification Migration | Notifications v3 API | Alerts v7 API or Data Forwarder - Alert Schema 2.0.0 | September 2023 | October 31, 2024 |
SDK impacted by deactivation of APIs
| Migration Guide | Deprecated SDK | Replacement SDK | Deprecated Date | Deactivation Date of APIs |
|---|---|---|---|---|
| CBAPI - legacy python SDK Migration | CBAPI SDK | Carbon Black Cloud Python SDK (CBC SDK) | January 2021 | July 31, 2024 |
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 | Related Migration Guides |
|---|---|---|---|
| API | July 31, 2024 | October 31, 2024 | Audit Log Access Level Migration
Devices Migration Policy Migration |
| LIVE_RESPONSE | July 31, 2024 | October 31, 2024 | Live Response Migration
and those for API type: Audit Log Access Level Migration Devices Migration Policy Migration |
| SIEM | October 31, 2024 | January 31, 2025 | Notification Migration |
API Usage
You can determine if you are using APIs that are being deactivated by navigating to Settings > API Access in your Carbon Black Cloud console.
- If the access level type is
API, use the session renewal time to determine the last time that key called one of the following APIs, and migrate if needed.- integrationServices/v3/devices - move to devices v6 and a custom access level
- integrationServices/v3/policy - move to Policy Service and a custom access level
- integrationServices/v3/auditlogs - update the integration to use a custom API key and a custom access level
- If the access level type is
LIVE_RESPONSE, use the session renewal time to determine the last time that key called one of the following APIs and migrate if needed.- The same routes as for API key - follow migration instructions above
- integrationServices/v3/cblr - Legacy Live Response - update to Live Response and a custom API key
- If the access level type is
SIEM- integrationServices/v3/notifications - see the migration guide to determine whether the data forwarder, syslog connector using the Alerts v7 API, or another option is right for you
- integrationServices/v3/notifications - see the migration guide to determine whether the data forwarder, syslog connector using the Alerts v7 API, or another option is right for you
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
New survey coming soon!
Last modified on March 12, 2024