Generate an API ID and API Secret Key

Generate an API key from the Carbon Black Cloud console and use the generated API key to establish a connection between the Carbon Black Cloud console and the Carbon Black Cloud Workload Appliance that is deployed in the vCenter Server. You can configure one appliance per vCenter Server. You can configure multiple appliances for your organization. If you are configuring multiple appliances, you must generate a separate API key for each appliance.

Use the pre-defined custom access level, and generate an API key for that appliance. You can use the same custom access level to configure multiple appliances for your organization.

Prerequisites

• Deploy the Carbon Black Cloud Workload Appliance in the vCenter Server.
• Use the CWP Appliance custom access level for appliances in your organization. Starting with version 1.2, the pre-defined custom access level for your appliance holds all necessary permissions.
• Register Carbon Black Cloud Workload Appliance with vCenter Server

Procedure

1. Log in to the Carbon Black Cloud console.
2. In the left navigation pane, go to the Settings > API Access page.
3. Click the API Keys tab and click Add API Key.
   The Add API Key window displays.

   

4. Enter a unique name for the appliance API key.
5. From the Access Level type dropdown menu, select Custom.
6. From the Custom Access Level dropdown menu, find and select the CWP Appliance custom access level for the appliance.
7. Click Save.
   The Carbon Black Cloud console generates the API ID and API secret key.
8. Copy the API ID and API secret key values and paste them into a plain text editor.

   You will use these values later to establish a connection between the appliance and the Carbon Black Cloud console.

   Important: You can use only one API ID and secret key per appliance.

What to do next

Register the Carbon Black Cloud Workload Appliance with Carbon Black Cloud.

Tip:

To retrieve the keys at a later time, perform the following steps.

1. In the left navigation pane, click Settings > API Access > API Keys.
2. Go to the appliance API name and click the down arrow next to the Edit icon.
3. Click API Credentials.

   The API Credentials dialog box appears. Copy the keys.