# Carbon Black Cloud

## Connection Requirements

{% stepper %}
{% step %}

### Domain

Enter the domain of your Carbon Black Cloud instance. This is the URL where the service is hosted.
{% endstep %}

{% step %}

### API Key Credentials

* Go to Settings > API Access > API Keys tab in the Carbon Black Cloud console.
* Select Add API Key from the far right.
* Give the API Key a unique name and select the appropriate access level. If you select Custom, ensure you choose the Access Level created previously.
* Important: Access Level types of `API`, `LIVE_RESPONSE`, and `SIEM` are deprecated. Refer to the Migration Guides for details on moving to new APIs.
* Click Save. You will then be provided with your API Key Credentials: API Secret Key (store this securely, as it cannot be retrieved after initial creation)
* API ID

{% hint style="info" %}
Access Level types of `API`, `LIVE_RESPONSE`, and `SIEM` are deprecated. Refer to the Migration Guides for details on moving to new APIs.
{% endhint %}
{% endstep %}

{% step %}

### Organization Key (`org_key`)

Most Carbon Black Cloud APIs or Services require an `org_key` in the API request path to support customers who manage multiple organizations.\
You can find your `org_key` in the Carbon Black Cloud Console under Settings > General. If Carbon Black Cloud manages your identities, it is also available on Settings > API Access.

{% hint style="info" %}
When inserting your Org Key, do not include any `<>` or `{}` brackets around the value.
{% endhint %}
{% endstep %}

{% step %}

### Https Proxy

Https Proxy url. (optional)
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
Please perform a connection test to ensure there is a valid connection to the host.\
When the discovery operation is finalized, you will be able to see the details on the Assets page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.octoxlabs.com/adapters/adapters/carbon-black-cloud.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.