This section will take you through the configuration steps to configure API Access on the Carbon Black Cloud console to get alert logs on Carbon Black Cloud Beat.
Prerequisites
-
You must have access to Carbon Black Cloud Console.
-
You must have valid hostname to access the Carbon black cloud console (On purchase of carbon black cloud platform product user should get the hostname and login credentials) Follow this for more information on hostname https://developer.carbonblack.com/reference/carbon-black-cloud/authentication/#hostname.
Configuration Steps
-
Log on to the Carbon Black Cloud Console using the hostname provided to you by VMware Carbon Cloud for your organization. Enter Email Address and Password to log on or log on via SSO.
-
Click Settings on the left panel.
-
Select API Access under Settings.
-
On the API Access page, go to the Access Levels tab.
-
Click Add Access Levels on the top right.
-
Fill out the following fields to define your Access Level:
NameDescriptionAlert Read Permission -
Click Save to save the Access Level.
-
Verify that your Access Level is visible in the list.
-
Go to the API Keys tab.
Note the ORG KEY on this page. You will need it to configure the Carbon Black Cloud Beat.
-
Click Add API Key on the top right.
-
Name your API Key.
-
Select Custom from the Access Level Type dropdown.
-
Select your created access level from the Custom Access Level dropdown.
-
Click Save to save the configuration.
A pop up notifying you that the API Key was created appears on the screen.
Note the API ID and API Secret Key. These credentials will be used to configure the Carbon Black Cloud Beat.