You must generate an API key from the Carbon Black Cloud console and then use the generated API key to establish a connection between the Carbon Black Cloud console and the Sensor Gateway deployed in the vCenter Server. If you are configuring multiple Sensor Gateways, generate a separate API key for each instance.

Use the pre-defined custom access level and generate an API key for the Sensor Gateway. You can use the same custom access level to configure multiple Sensor Gateway instances for your organization.

Procedure

  1. Log in to the Carbon Black Cloud console.
  2. On the left navigation pane, click Settings > API Access > API Keys.
  3. Click Add API Key.
  4. Enter a unique name for your Sensor Gateway API key.
  5. From the Access Level type dropdown menu, select Custom.
  6. From the Custom Access Level dropdown menu, select Sensor Gateway.
    Setting the access level for a Sensor Gateway instance.
  7. To generate the API key, click Save.
    The Carbon Black Cloud console generates the API ID and API secret key.
  8. Copy the credentials.
    You will use these keys to establish a connection between the Sensor Gateway and Carbon Black Cloud.
    Note: You can use only one set of API ID and secret key per Sensor Gateway. After you use the generated credentials for your Sensor Gateway, you cannot use the same API ID and secret key for any other instance.
  9. To view and copy the API ID at a later time, or to generate a new API secret key, perform the following steps:
    1. On the left navigation pane, click Settings > API Access > API Keys.
    2. Go to the Sensor Gateway API name click the down-arrow in the Actions column.
    3. Select API Credentials.
      The API Credentials dialog box displays. You can copy the API ID. The API Secret Key cannot be viewed nor copied. It can only be regenerated..