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 any deprecated or soon-to-be-deprecated API or schema to its replacement
- A Migration Checklist with common migration tasks
- Resources for additional support
Migration Summary
Are you using a supported integration?
For most Carbon Black Cloud customers, the only thing you need to do to ensure you’re leveraging currently-supporte dAPIs is to update any of these integrations and SDKs.
- Splunk SIEM - Update to v2.x.x
- Instructions
- Earlier versions used Alerts v6 API, Data Forwarder Alert Schema v1, Live response v3 API and
APItype Access Level
- Splunk SOAR - Update to v2.x
- Instructions
- Earlier versions used Alerts v6 API and Enriched Events API
- ServiceNow - Update to ITSM App v3.0.0, SecOps App v3.0.0, Vulnerability Response v2.0.0
- Instructions
- Earlier versions used Alerts v6 API and Data Forwarder Alert Schema v1
- IBM QRadar App - Update to v2.3
- Instructions
- Earlier versions used Alerts v6 API, Data Forwarder Alert Schema v1 and
APItype Access Level
- Carbon Black Cloud SDK - Update to Carbon Black Cloud SDK v1.5.x or later
- Instructions
- Earlier versions used now-deactivated APIs
- CBAPI - Update to Carbon Black Cloud SDK v1.5.x or later
- CBAPI is the very early Python SDK that pre-dated Carbon Black Cloud SDK
- It uses Alerts v6 API, Policy v3 API, Live Response v3 API (live response)
- Instructions
Are you using a custom integration?
If you are using a custom integration, review the APIs that are being used against the list below and make changes as necessary.
APIs to be deprecated
| Migration Guide | Deprecated API | Replacement API | Deprecation Date | Deactivation Date |
|---|---|---|---|---|
| Audit Log Migration | Audit Log v3 REST API | Audit Logs v1 API | TBD | TBD |
| TBD | VM Workloads Search API v1 | VM Workloads Search API v2 | August, 2022 | TBD |
Recently Deactivated APIs
| Deprecated API | Routing Prefix | Replacement API | Deactivation Date |
|---|---|---|---|
| Alerts v6 API | /appservices/v6/orgs/{org_key}/alerts/ | Alerts v7 API | September 2024 |
| Data Forwarder Config v1 API | /event_forwarder_config/v1/orgs/{org_key}/configs/ | Data Forwarder Config v2 API | October 2024 |
| Devices v3 REST API | /integrationServices/v3/device/ | Devices v6 API | September 2024 |
| Enriched Events Search API | /api/investigate/v2/orgs/{org_key}/enriched_events/ | Observations v2 API | September 2024 |
| Live Response v3 API | /integrationServices/v3/cblr/ | Live Response v6 API | September 2024 |
| Notifications v3 API | /integrationServices/v3/notification/ | Alerts v7 API or Data Forwarder - Alert Schema 2.0.0 | October 2024 |
| Policy v3 REST API | /integrationServices/v3/policy/ | Policy Service v1 API | September 2024 |
| Process Search Suggestions v1 | /api/investigate/v1/orgs/{org_key}/processes/search_suggestions | Process Search Suggestions v2 | September 2024 |
| Process Search Validation v1 | /api/investigate/v1/orgs/{org_key}/processes/search_validation | Process Search Validation v2 | September 2024 |
| Sensor Update Services v2 API | /sus/v2/ | Sensor Update Services v3 API | September 2024 |
SDKs 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 | September 2024 |
| Carbon Black Cloud Python SDK Changelog | CBC SDK 1.4.3 and earlier | CBC SDK 1.5.0 onwards | October 2023 | September 2024 |
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 CB Developer Network community forum to discuss issues and get answers from other API developers in the CB Developer Network
- Report bugs and product issues to Broadcom Support
- View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.
Last modified on March 20, 2025