Skip to main content

​
What Living Security needs

Scopes: Read access to alerts (via Custom Access Level) Required role: Administrator or equivalent with access to Settings → API Access

​
Prerequisites

  • You must be signed in to the Carbon Black Cloud console with a role that allows managing API keys.
  • You need permission to create Custom Access Levels for RBAC.

​
Part A — In VMware Carbon Black Cloud

Your Carbon Black administrator completes these steps.
1

Create a Custom Access Level

Carbon Black Cloud uses Role-Based Access Control (RBAC). Create a Custom Access Level with minimum required permissions.
  1. Sign in to your Carbon Black Cloud console.
  2. Navigate to Settings → API Access.
  3. Click the Access Levels tab.
  4. Click Add Access Level.
  5. Enter a name (e.g., Living Security Platform) and optional description.
  6. In the permissions table, grant the following under Alerts:
  1. Click Save.
These are the minimum permissions required. Grant only what is listed here for least-privilege access.
2

Create an API key

  1. Go to Settings → API Access.
  2. Click the API Keys tab.
  3. Click Add API Key.
  4. Fill in the fields:
    • Name — A descriptive name (e.g., Living Security Platform)
    • Access Level Type — Select Custom
    • Access Level — Select the access level from Step 1
  5. Click Save.
3

Copy your API credentials

After saving, Carbon Black Cloud displays:
  • API Secret Key — A long alphanumeric string
  • API ID — A shorter alphanumeric string
Construct your API key by combining them:
Example: ABCDEFGHIJKLMNO123456789/ABCD123456
The API Secret Key is displayed only once. If you navigate away without copying it, you must reset the secret or delete the key and create a new one.
4

Locate your Org key

  1. Go to Settings → API Access.
  2. Click the API Keys tab.
  3. Your Org Key is displayed near the top of this page (e.g., ABCD1234).
5

Identify your environment hostname

Living Security defaults to defense.conferdeploy.net (Prod 02). If your organization uses a different environment:
If your organization uses a non-default environment, contact your Living Security Customer Success Manager to configure the correct host.

​
Part B — In the Living Security Platform

The program owner completes this step, or the system admin if using delegated setup.
1
You are now connected to VMware Carbon Black Cloud.

​
Troubleshooting

The API key is invalid or the secret has been reset. Generate a new API key from Settings → API Access → API Keys.
The Access Level is missing one or more required permissions. Access Level permissions cannot be changed retroactively on a key — update the Access Level itself, or create a new Access Level and API key with the correct permissions.
If syncs fail but credentials are correct, your organization may use a non-default Carbon Black environment. Check your console URL and contact support to configure the correct hostname.
The API key must be in {secret}/{id} format. Verify you combined the API Secret Key and API ID with a forward slash separator.