Cloud Platform APIs and Integrations
Introduction
We have extended the capabilities of the Devices API by improving the methods of retrieving device information, and adding functionality to perform actions. We have also extended the capabilities of the Alerts API by improving the methods of retrieving alerts, and adding functionality to manage the workflow by updating the alert status.
Getting Started
Platform APIs are available to all Carbon Black Cloud customers. These platform level APIs are augmented by product specific APIs. Below is a list of APIs available.
Authentication
Carbon Black Cloud APIs and Services are authenticated via API Keys. This means that in order to access the data in Carbon Black Cloud via API, you must set up Access Levels and API Keys in the Carbon Black Cloud Console. For more information see Authentication
Platform Integrations
See our latest integrations that utilize the platform APIs to enhance customer workflows.
Guides
See our latest guides for additional context beyond what the API documentation defines.
All Documents
Latest
| Document | Release Date |
|---|---|
| Access Profiles and Grants API v2 | May, 2021 |
| Alerts API v6 | September, 2019 |
| Devices API v6 | February, 2020 |
| Data Forwarder API v2 | November, 2021 |
| Data Forwarder Fields v1 | November, 2021 |
| Job Service API v1 | May, 2020 |
| Live Response API v6 | April, 2021 |
| Policy Service API v1 | April, 2022 |
| Processes Search API v1 v2 | October, 2020 |
| Reputation Overrides API v6 | June, 2021 |
| Sensor Update Services API v2 | August, 2020 |
| Search Fields - Processes and Enriched Events v2 | October, 2020 |
| User Management API v6 | May, 2021 |
| Vulnerability Assessment v1 | August, 2021 |
Note: Enriched Events Search API has moved under Endpoint Standard as this API is only available for customers with Endpoint Standard enabled. See Endpoint Standard.
Deprecated
| Document | Deprecated Date | Deactivated Date |
|---|---|---|
| Alerts v3 API (Previously Endpoint Standard) | September, 2019 | January 31st, 2022 |
| Devices v3 API (Previously Endpoint Standard) | September, 2019 | |
| Live Response API | April, 2021 | |
| Data Forwarder API v1 | November, 2021 |