> For the complete documentation index, see [llms.txt](https://docs.reveald.com/technical-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.reveald.com/technical-documentation/data-sources/carbon-black-cloud.md).

# Carbon Black Cloud

{% hint style="warning" %}
This feature is in Early Release/BETA. Please contact your Epiphany Systems support or sales contact to learn more.
{% endhint %}

## About This Document

This guide details the steps necessary to connect Carbon Black Cloud to the Epiphany Intelligence Platform. The Epiphany Intelligence Platform leverages data from tools like Carbon Black Cloud to provide greater visibility into the risks in your environment.

## **Overview**

Carbon Black Cloud allows API access by virtue of an API key, API ID, and Org Key. All of which can be created or found in the management console by an individual user. The permissions granted to the API key will be limited to those of the role it is assigned during creation.

The Epiphany Intelligence Platform only requires read rights to certain Carbon Black Cloud assets. A custom role will be built for Epiphany to ensure that minimal rights are given for Epiphany to achieve its collection.

There are two options to accomplish this; either is acceptable:

* **New User**: Create a new user with the custom role designated for use by Epiphany, and generate an API key and ID.
* **Existing User:** Leverage an existing user and follow the steps to generate a custom role, API key, and API ID.

## **Version Compatibility**

* **Epiphany Collector**: Version 1.0 and later.
* **Carbon Black Cloud**: REST API Version 6.0 and later.

## **Prerequisites**

* [ ] Access to the Carbon Black Cloud UI
* [ ] Ability to create a user, or access to an existing user with viewer role

## **What is Needed for Integration**

* [ ] The Org Key
* [ ] The API key
* [ ] The API ID
* [ ] The URL of the Carbon Black appliance

[Legal Notice](/technical-documentation/legal-notice.md)