VMware Carbon Black EDR Response Integration via API

Purpose

This guide explains how to connect Logsign to VMware Carbon Black EDR (formerly known as Cb Response) so that Logsign Incidents and Alarms can query and act on Carbon Black EDR data directly from the Logsign console. This is a Response/Action integration, configured under Settings > Integrations > Responses, not a log collection poller. Once a device is configured, analysts can trigger any of the available methods manually from an incident, or reference them in automation rules, to pull process and binary details, search alerts, manage the hash blacklist and watchlists, look up sensor status, and run interactive Live Response sessions on an endpoint.

Carbon Black EDR is normally deployed on premises or as a single-tenant hosted instance, so this integration talks to your own Carbon Black EDR server URL rather than a shared cloud endpoint.

Prerequisites

You need the following before configuring the integration:

  • A reachable Carbon Black EDR server URL (on-premises console or your hosted EDR instance) that Logsign can connect to over HTTPS.
  • A Carbon Black EDR user account with an API token, created according to the least-privilege guidance in Step 1 below. Do not use a Global Administrator account for this integration unless your organization has a specific reason to.
  • Network access from the Logsign server to the Carbon Black EDR server on the HTTPS port used by its console (typically 443).
  • If your Carbon Black EDR server uses a certificate that is not trusted by a public certificate authority (common in on-premises deployments with self-signed certificates), decide in advance whether you want Logsign to skip TLS certificate validation for this connection. See the note under Step 2 about the Skip Certificate Validation field, since its default behavior is not what most security teams expect.

Step 1: Generate an API token in Carbon Black EDR

Carbon Black EDR issues one API token per user account, and that token inherits every permission assigned to the user it belongs to. There is no separate concept of an API-only service account with its own scoped permission set the way some modern SaaS products offer; the token is only as restricted as the underlying user's role. Because of this, the most important decision in this step is which user you generate the token for, not the token itself.

Carbon Black EDR's role model is Team-based. Each user is assigned to one or more Teams, and each Team grants one of four base roles over a set of sensor groups: Administrator, Analyst, Viewer, or No Access. Administrators can manage users, teams, and server settings in addition to endpoint data; Viewers can read endpoint and alert data but cannot use Live Response, sensor isolation, or hash banning; Analysts sit in between and can perform response actions, but only after being granted specific enhanced permissions on top of the base Analyst role.

For this integration, create (or reuse) a dedicated user with the Analyst role scoped to the sensor groups you want Logsign to act on, and grant it only the enhanced permissions the methods you plan to use actually require:

Enhanced permissionRequired for
Live ResponseList Live Response Sessions, Start Live Response Session, Execute Command With Live Response, Close Live Response Session
Banning hashesBlock Hash (adds an entry to the blacklist)

Do not grant Isolating sensors or Uninstalling sensors permissions for this integration. Neither capability is exposed by any method in this integration (see Notes and Limits below), so granting them only widens the account's blast radius without giving Logsign anything to use. All read-only methods (process search, binary search, alert search, watchlist, blacklist, endpoint and ingress whitelist lookups) work with the base Analyst or even Viewer role and do not need any enhanced permission.

Once the user and its role are set up, generate the token from that account:

  1. Log in to the Carbon Black EDR console as the user you prepared above.
  2. Click the username in the upper right corner and select My Profile (or Profile info, depending on your EDR version).
  3. Click API Token in the left-hand menu.
  4. If no token is shown, click Reset to generate one. If a token already exists and you want to rotate it, clicking Reset invalidates the old token immediately, so update any other integration using it at the same time.
  5. Copy the token value. Carbon Black EDR does not mask or re-display it later beyond this screen, so store it securely (for example in the Logsign configuration you set up in Step 2) before navigating away.

The exact menu wording (My Profile vs. Profile info, API Token vs. API Key) varies slightly between Carbon Black EDR versions; the underlying flow (username menu > profile > API token > Reset) has been consistent across the versions checked in Broadcom's published documentation as of July 2026.

Step 2: Configure the integration in Logsign

In the Logsign console, go to Settings > Integrations > Responses, search for VMware Carbon Black EDR, click Configure, then +Device to add a new instance. Fill in the following fields:

FieldRequiredDescription
Server UrlYesThe base URL of your Carbon Black EDR server, including the https:// scheme, with no trailing slash and no /api/v1 or /api/v2 suffix. Logsign appends the API path itself for every call. Correct: https://cbr.yourcompany.com. Incorrect: https://cbr.yourcompany.com/api/v1/ or cbr.yourcompany.com without a scheme. There is no fixed list of Carbon Black EDR regional URLs to choose from, since this is your own on-premises or single-tenant server address, not a shared multi-tenant cloud host.
Api KeyYesThe API token generated in Step 1, entered as a masked/password field. Logsign sends it on every request as the X-Auth-Token HTTP header.
Insecure Skip VerifyYesWhether Logsign skips TLS certificate validation when connecting to Server Url. This field defaults to enabled (true) in the current manifest, meaning certificate validation is skipped by default. If your Carbon Black EDR server has a certificate issued by a trusted public or internal CA, disable this field so Logsign validates the certificate chain normally. Leave it enabled only if you knowingly rely on a self-signed or otherwise untrusted certificate and accept the reduced protection against man-in-the-middle connections.

Click Create to save the device. You can use the built-in connection test (which internally calls the Get Watchlist method) to confirm the Server Url and Api Key are correct before relying on the device in an automation rule.

Available Methods

The methods below are grouped by what they do. Each one can be triggered manually from an Incident or wired into an automation rule once the device above is configured. Field names shown are the exact argument names used by the method.

Process investigation

Process Search runs a Carbon Black EDR process search query and returns matching process executions.

ArgumentRequiredDescription
qYesCarbon Black EDR process search query string (Solr-style query syntax, for example process_name:chrome.exe).
rowsNo (default 10)Number of results to return.
startNo (default 0)Offset for paging through results.
sortNoSort expression, e.g. last_update desc.
cb_comprehensive_searchNoSent as the cb.comprehensive_search query parameter to search across all segments of a process instead of just the most recent one.
cb_groupNoSent as the cb.group query parameter to restrict the search to a sensor group.

Process Summary returns a process's parent, siblings, and children for a given process and segment ID.

ArgumentRequiredDescription
processIdYesProcess ID, typically taken from a Process Search or Search Alerts result.
segmentIdYesSegment ID of the specific process execution.

Process Segment Details lists the recorded segments of a process, with per-segment event counts (file, registry, module, network, and cross-process activity).

ArgumentRequiredDescription
processIdYesProcess ID to look up segments for.

Process Event Details returns the detailed event stream (registry modifications, file modifications, module loads) for a process segment.

ArgumentRequiredDescription
processIdYesProcess ID.
segmentIdYesSegment ID.
cb_event_startNoSent as cb.event_start, offset into the event list.
cb_event_countNoSent as cb.event_count, number of events to return.

Process Preview returns a condensed summary view of a process segment, optionally filtered by a search term.

ArgumentRequiredDescription
processIdYesProcess ID.
segmentIdYesSegment ID.
qNoOptional query to filter the preview.

Collective Defense Cloud Query queries Carbon Black's threat intelligence feeds for a process segment and returns any matching IOC hits.

ArgumentRequiredDescription
processIdYesProcess ID.
segmentIdYesSegment ID.

Binary investigation

Binary Search searches Carbon Black EDR's binary (executable) index.

ArgumentRequiredDescription
qYesBinary search query, e.g. md5:F2C7BB8ACC97F92E987A2D4087D021B1.
rowsNo (default 10)Number of results to return.
startNo (default 0)Offset for paging.
sortNoSort expression.

Retrieve Binary Metadata returns full metadata (digital signature status, file version, publisher, observed paths) for a single binary.

ArgumentRequiredDescription
md5YesMD5 hash of the binary.

Alerts

Search Alerts searches Carbon Black EDR's alert index (watchlist hits, threat intel matches).

ArgumentRequiredDescription
qYesAlert search query, e.g. status:Unresolved.
rowsNo (default 10)Number of results to return.
startNo (default 0)Offset for paging.
sortNoSort expression.

Hash blocking (banning)

Get Blacklist returns the current list of banned (blocked) MD5 hashes and their ban history. It takes no arguments.

Block Hash adds an MD5 hash to the blacklist, preventing it from executing on sensors going forward.

ArgumentRequiredDescription
md5hashYes (see note)MD5 hash to block.
textNoFree-text reason recorded against the ban, shown later in the blacklist audit trail.

Note: the underlying method reads both md5hash and text from the request, but at the time of writing the Block Hash method's argument schema is not populated, so the Logsign UI may not render input fields for them automatically. If you do not see fields for md5hash and text when configuring a Block Hash action, contact Logsign support before relying on this method in production; do not assume it silently works with an empty hash.

Watchlists

Get Watchlist returns the list of configured watchlists (saved searches that generate alerts on new matches). It takes no arguments. This is also the method Logsign calls internally when you use the connection test on this device.

Endpoints (sensors)

Get Endpoint By Id returns full status for a single sensor: health, uptime, OS, last check-in time, and current network isolation state.

ArgumentRequiredDescription
idYesNumeric sensor ID.
hostnameNoFilter/cross-check by hostname.
IPAddrNoFilter/cross-check by IP address.
groupIdNoFilter by sensor group ID.
inactiveFilterDaysNoExcludes sensors inactive for more than this many days.

Get Endpoints returns the same status fields for all sensors matching the given filters.

ArgumentRequiredDescription
hostnameNoFilter by hostname.
IPAddrNoFilter by IP address.
groupIdNoFilter by sensor group ID.
inactiveFilterDaysNoExcludes sensors inactive for more than this many days.

Both endpoint methods return the sensor's is_isolating and network_isolation_enabled fields as read-only status. This integration does not include a method to trigger or lift network isolation; see Notes and Limits.

Ingress event filtering (whitelists)

Get Ingress Whitelist By Id returns a single ingress filter definition (path or command-line filters that suppress event collection for matching activity).

ArgumentRequiredDescription
idYesIngress whitelist entry ID.

Get Ingress Whitelists returns all configured ingress filter entries. It takes no arguments.

Live Response

These four methods drive Carbon Black EDR's Live Response feature, which opens an interactive remote session on a sensor and runs commands on it. They require the Live Response enhanced permission on the API user (see Step 1).

List Live Response Sessions returns all Live Response sessions and their status (pending, active, or closed). It takes no arguments.

Start Live Response Sessions opens a new Live Response session against a sensor.

ArgumentRequiredDescription
sensorIdYesSensor ID to open the session on.

After requesting the session, Logsign waits approximately 3 seconds before fetching the session status once and returning it. If the sensor takes longer than that to accept the session, the returned status may still show pending rather than active; use List Live Response Sessions afterward to confirm the final state.

Execute Command With Live Response runs a single Live Response command inside an existing session.

ArgumentRequiredDescription
sessionIdYesID of an active Live Response session.
nameNoLive Response command name, e.g. process list. Supported command names depend on the sensor OS and Carbon Black EDR version; see the session's supported_commands list returned by List Live Response Sessions.

As with session start, Logsign waits approximately 3 seconds after submitting the command before fetching its result once. Commands that take longer than that to complete may be returned with a non-final completion status.

Close Live Response Session closes an active session.

ArgumentRequiredDescription
sessionIdYesID of the session to close.

Notes and Limits

  • This integration does not include a method to isolate or unisolate a sensor's network connection, even though Carbon Black EDR itself supports this action and exposes is_isolating and network_isolation_enabled as read-only fields on Get Endpoint By Id and Get Endpoints. If your use case depends on triggering network isolation from Logsign, that capability is not currently available through this integration and would need to be requested as a product enhancement.
  • Authentication is a single per-user API token sent as the X-Auth-Token header, not OAuth2. There is no token expiry or refresh flow to manage; the token is valid until it is manually reset in the Carbon Black EDR console.
  • Insecure Skip Verify defaults to enabled in the current configuration schema, which skips TLS certificate validation. Review this setting deliberately for every device rather than accepting the default, especially for internet-reachable Carbon Black EDR servers.
  • The Block Hash method's argument schema does not currently declare its md5hash and text parameters, even though the underlying integration code reads and uses both. Confirm with Logsign support that these fields are exposed in your console version before relying on Block Hash for automated response.
  • Start Live Response Sessions and Execute Command With Live Response each include a fixed roughly 3-second wait before checking the result once. For slower sensors or longer-running commands, the immediate response may show a non-final status (pending/incomplete); follow up with List Live Response Sessions or re-run the check if needed.
  • Carbon Black EDR's REST API does not publish a documented per-account rate limit for this on-premises product the way its cloud-hosted counterpart does; if you see HTTP 429 responses, treat it as a signal to reduce request frequency rather than a fixed quota you can plan around precisely. This has not been independently verified against a live Logsign deployment.
  • Carbon Black EDR is typically self-hosted or single-tenant hosted, so there is no fixed list of regional API base URLs to choose from. The Server Url field always points at your own instance.

Troubleshooting

Symptom / HTTP statusLikely causeWhat to check
401 UnauthorizedThe Api Key is missing, incorrect, or was reset in Carbon Black EDR after being entered in Logsign.Confirm the token in Logsign matches the current token under My Profile > API Token for the integration user. Reset and re-enter if in doubt.
403 ForbiddenThe token's user does not have the enhanced permission needed for the requested method (most commonly Live Response or Banning hashes), or the sensor/data being accessed is outside that user's assigned Team/sensor groups.Check the integration user's Team assignment and enhanced permissions per Step 1. Avoid diagnosing this by switching to a Global Administrator token; instead grant the specific missing permission.
404 Not FoundThe processId, segmentId, sensorId, or session ID passed to the method does not exist, has expired, or belongs to a different Carbon Black EDR server; or Server Url is malformed (wrong host, missing scheme, or includes an API path suffix).Re-check the ID values against a fresh Process Search / List Live Response Sessions call, and re-check the Server Url format described in Step 2.
429 Too Many RequestsRequest volume from this integration (manual triggers, automation rules, or polling) exceeded what the Carbon Black EDR server currently allows.Reduce trigger frequency and check with your Carbon Black EDR administrator whether server-side throttling settings apply to this account.
Get Blacklist or Get Watchlist returns an empty listNo blacklist entries or watchlists are defined on the server yet.This is expected behavior, not an error. Verify by checking the same data in the Carbon Black EDR console.
Block Hash appears to succeed but the hash is not enforcedThe Block Hash argument fields (md5hash, text) may not be exposed in the Logsign UI due to the manifest gap noted above, so the request could be sent with an empty or malformed hash.Verify the hash was actually added by running Get Blacklist afterward and checking for the expected md5hash value. Contact Logsign support if the fields are not visible when configuring the action.
Live Response session or command stays in "pending" statusThe fixed roughly 3-second wait in Start Live Response Sessions / Execute Command With Live Response elapsed before the sensor responded.Re-check status with List Live Response Sessions, or re-run Execute Command With Live Response once the session shows active.
TLS / certificate errors connecting to Server UrlInsecure Skip Verify is disabled and the Carbon Black EDR server presents a self-signed or otherwise untrusted certificate.Either install a certificate trusted by Logsign's certificate store on the Carbon Black EDR server, or knowingly enable Insecure Skip Verify after accepting the associated risk.
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more
Become a Certified Logsign User/Administrator
Sign-up for Logsign Academy and take the courses to learn about Logsign USO Platform in detail. Enjoy the courses, and get your badges and certificates. In these courses, you'll learn how to use Logsign in your work and add value to your career.
Visit Our Blog
Our Logsign USO Platform illustrate our expertise. So do the blog. Through our blog posts, deepen your knowledge on various SecOps topics or get updated about important news & modern approaches for cybersecurity. Get into the habit of reading valuable information provided by Logsign. Be a step ahead.