Step 1D: Generate API ID and API Secret Key

You must 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 Carbon Black Cloud Workload appliance 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, generate a separate API key for each appliance.

After the appliance is deployed, using the created custom access level, generate an API key for the appliance. You can use the same custom access level to configure multiple appliances for your organization.

Prerequisites

• You have deployed the Carbon Black Cloud Workload appliance in the vCenter Server. To know more about how to deploy the appliance in the vCenter Server, refer Step 1A: Deploy Carbon Black Cloud Workload appliance in the vCenter Server.
• The custom access level is available for appliances in your organization. Creating a custom access level for your appliance is a one-time task and is available only for the Carbon Black Cloud Super Admin role.

Procedure

1. Log in to the Carbon Black Cloud console.
2. From the left navigation pane, click the Settings > API Access > API Keys page.
3. On the API Keys tab, click Add API Keys.
   
4. Enter a name for your appliance API key. The name must be UNIQUE for your Carbon Black Cloud organization.
5. Select Custom from the Access level type drop-down menu.
6. From the Custom Access Level drop-down menu, find and select the custom access level created by the Super Admin for your appliance. For details, refer to Step 1C: Create Custom API Access Level for Carbon Black Cloud Workload Appliance.
   Tip: Look for Appliance in the name.
7. Click Save.
   The API ID and API secret key are generated.

   

8. Copy both the keys. You use these keys later to establish a connection between the appliance and the Carbon Black Cloud console.
   Note: You can use only one API ID and secret key per appliance. Once you use the generated API ID and secret key for your appliance, you cannot use the same API ID and secret key for any other appliance.

What to do next

Use the keys to establish a connection between Carbon Black Cloud Workload appliance and the Carbon Black Cloud console.

If you want to view and copy the keys later, perform the following steps.

1. Go to the Settings > API Access > API Keys page.
2. Go to the appliance API name created earlier and click the down arrow next to the Edit button.

   

3. Click API Credentials.

   The API Credentials dialog box appears. Copy the keys.