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 you deploy the 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

  • Verify you have deployed the Carbon Black Cloud Workload appliance in the vCenter Server. For details, see Step 1A: Deploy 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 the necessary permissions.

Procedure

  1. Log in to the Carbon Black Cloud console.
  2. From the left navigation pane, go to the Settings > API Access page.
  3. Select the API Keys tab and click Add API Key.
    The Add API Key window displays. The Add API Key page where you can name the key and define custom access level.
  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 CWP Appliance custom access level for your appliance.
  7. Click Save.
    The Carbon Black Cloud console generates the API ID and API secret key.

    A view of the generated by the Carbon Black Cloud console API credentials with available icons for copying the credentials.

  8. Copy both of 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 tab.
  2. Go to the appliance API name created earlier and click the down arrow next to the edit icon.

    The screens for retrieving the generated API credentials with available icons for copying the credentials.

  3. Click API Credentials.

    The API Credentials dialog box appears. Copy the keys.