Carbon Black Cloud EDR FAQ

Carbon Black Cloud EDR FAQ

What is Carbon Black Cloud EDR?

Carbon Black Cloud EDR is a unified endpoint security platform for preventative protection, post-breach detection, automated investigation, and response.


How does Carbon Black Cloud EDR integrate with my Vectra platform?

Integration with Carbon Black Cloud EDR adds host context to aid in host identification during a security investigation. When Detect sees a host session come online, it polls Carbon Black Cloud EDR for host information. Host information may include the following:

  • Machine ID
  • Machine name
  • Operating system
  • Isolation status

Carbon Black Cloud EDR host context is available under the Host Details tab of individual Host pages.

How do I enable the Carbon Black Cloud EDR integration in Detect?

Carbon Black Cloud EDR is configured under the EDR Integrations Tab. In your Detect UI, navigate to Settings -> EDR Integrations -> Carbon Black Cloud:

  • Select Edit on the far right-hand side within the Carbon Black Cloud row.
  • Toggle Enable integration with Carbon Black Cloud to On.


  • Enter your Carbon Black Cloud HostnameOrg Key, API Secret Key, and API ID. The username and password should be for an account with permissions defined below. If you do not have this information, please check the section below on how to get this information correctly.


  • Click Save.
  • Once the credentials have been validated, the UI will provide confirmation that your configuration has been saved.
  • Your Carbon Black Cloud EDR setup is now complete.


Where can I find my Carbon Black Cloud Information to integrate with Vectra?

To get credentials for Carbon Black Cloud EDR for use with Vectra:

  • Log into your Carbon Black Cloud Dashboard
  • Navigate to Settings > API Access
  • Here you will see all the accounts that you have created. In order to get the Vectra EDR Integration working, there needs to be an API Key with the following permissions. (


  • If you do not have this, please follow the steps below. However, if you do have an API Key with this role, use the corresponding Org Key, Hostname, API Secret Key, and APP ID.
  • Navigate to the Access Levels and click on Add Access Level.


  • Provide a name and description for the access level. Make sure you remember which name you provided it as it will be used later.


  • Mark the checkboxes corresponding to the permissions mentioned above.


  • Press Save to save this custom permission.
  • Navigate back to API Keys and select Add API Key.


  • Provide the Name you want to use for the API Key. From the drop down choose Custom for Access Level Type and then choose your access level in the Custom Access Level.


  • Press Save.
  • Once you press save, you will be given you API Secret Key and APP ID.


  • You now have all the information to set up the Carbon Black Cloud EDR integration.

Why do I not see Carbon Black Cloud EDR as an External Connector?

Vectra introduced native integration support for Carbon Black Cloud EDR in release version 6.6. Please make sure you are running Detect version 6.6 or greater. You can check the current software version by navigating to Settings -> General -> Version in the Detect UI.

Can I use Advanced search to query for Carbon Black Cloud EDR hosts?

Right now, we do not have support for advanced search for Carbon Black Cloud EDR host artifacts. We plan on releasing this feature in a coming releasing.

Can Carbon Black Cloud EDR be used for Host Lockdown?

Yes, Detect release version 6.6 introduced support for Host Lockdown using Carbon Black Cloud EDR.

Host Lockdown Information:

What is Host Lockdown?

Host Lockdown is a feature of Detect that gives users the ability to temporarily disable network hosts during a security investigation. Host Lockdown is enforced through the use of Carbon Black Cloud's host isolation capabilities. Host Lockdown can run in an automated or manual mode. In automated mode, action is taken once privilege, threat and certainty score thresholds have been passed. In manual mode, a security analyst can isolate a host directly from a Detect Host page.

Why is disabling a host necessary during a security investigation?

Disabling a host isolates an attacker's machine from the network and prevents subsequent use of that machine for kill chain progression. Disabled hosts will limit an attacks blast radius, buying analysts critical time to conduct a thorough security investigation.

How does Host Lockdown work?

Host Lockdown requires Detect to be integrated with your Carbon Black Cloud system. When a Host Lockdown is instantiated, Detect will notify Carbon Black Cloud to isolate the host. 

How does a host get locked down?

There are two ways to utilize Host Lockdown:

  1. Manually, where a host is locked by a Detect user.
  2. Automatically, where Detect can be configured to automatically lock hosts based on configured Observed Privilege, Threat and Certainty score thresholds.

How do I manually lockdown a host?

Carbon Black Cloud EDR enabled hosts will have a Host Lockdown widget in the sidebar of individual host pages. From there you can enable or disable Lockdown. Host can be manually locked from 1 hour up to 24 hours, in pre-configured time ranges. To lock a host, simply click the Disable Host button and select a pre-configured time range from the dropdown. The host will automatically be re-enabled once the selected time range has expired. Please note that enabling or disabling manual lockdown on a host will require the Detect user to have the Edit Host Lockdown RBAC permission enabled.

How do I automatically lockdown a host?

In Detect, navigate to Settings EDR Integrations Host Lockdown. From here you can enable the Host Lockdown feature itself, along with Automatic Lockdown and its required thresholds. Once you have enabled Automatic Lockdown, you will have the option to configure the automatic lockdown period, which can range from 1 hour up to 24 hours, in pre-configured time ranges, and set the Observed Privilege, Threat and Certainty score thresholds. After automatic Lockdown has been enabled, anytime a host's scores exceed the Observed Privilege, Threat and Certainty thresholds, the host will be isolated in the corresponding EDR for the configured time range.


Where can I check the lockdown status of a host?

All hosts will have a Host Lockdown widget in the sidebar of individual Host pages. From here you can see the host's current Lockdown status. If a host is locked down, the status will show time until the host is re-enabled and the username of the Detect user that enabled lockdown for that host. There is also an AP endpoint (/api/v2.1/lockdown/host) where you can pull a list of all current hosts that have been disabled via Lockdown. Please note that viewing Lockdown status will require the Detect user to have the View Host Lockdown RBAC permission enabled.

If a host gets locked down, will existing/open sessions be terminated?

Yes. Once a host gets isolated via Host Lockdown, the host gets isolated from the network so existing user sessions will timeout and, or terminate.

Once a host has been locked down, how can host isolation be removed?

Hosts may be removed from isolation via the following methods:

  • A user manually re-enables the host via Detect
  • Disable timer expires
  • The host is removed from isolation outside of Detect (in Carbon Black Cloud)

If I update my automatic Lockdown thresholds, will all hosts be re-evaluated?

No, adjusting the Lockdown thresholds will not retroactively apply to existing host scores, only when new host scores are calculated.

Is there API support for Host Lockdown?

Yes, for reporting of isolated hosts only. We may add support for enabling or disabling of hosts in a future release.

GET /api/v2.1/lockdown/host
   "host_id": 10,
   "locked_by": "admin",
   "unlock_date": "2020-06-09T15:21:06Z",
   "host_name": "def-1",
   "lock_date": "2020-06-09T14:21:06Z"

If a host is isolated outside of Detect (via Carbon Black Cloud) how does that appear in Detect?

The host's Lockdown status will indicate "Isolated from outside Cognito." Detect will always honor the state of isolation from the Carbon Black Cloud side. If isolation is set from the remote end, the host will need to be removed from isolation from the remote end.


Will the end user be notified when their host is locked down?

No, the end user is not notified whenever their host is disabled.

Will Detect administrators be notified when a host is locked down?

Yes, Detect admins will see email and syslog notifications when lockdown is enabled or disabled. Please note that in order to receive Host Lockdown email notifications, Host alert emails notification must be enabled under Settings / Notifications.

Can I use advanced search to pull information on isolated hosts?

As of release version 6.6, Advanced search for Host Lockdown is not supported. We will introduce Advanced search support in a future release.



Was this article helpful?
0 out of 0 found this helpful

Download PDF


Article is closed for comments.