Downloading Sensor Installer Packages via API

Products

• Carbon Black EDR

Issue/Introduction

Goal

To provide Carbon Black EDR administrators with the API endpoints and commands required to programmatically download sensor installer packages. Using the API can help bypass UI-related download issues and supports automation for sensor rollouts.

Environment

 

• Product: Carbon Black EDR (formerly Cb Response)

 

Resolution

API Endpoint Details

The following endpoints allow you to download a compressed archive containing the sensor installer and its associated settings file for a specific group.

• Supported Method: GET
• Authentication: Requires X-Auth-Token header.
• Parameters: None.

 

Target OS	API Endpoint Path	Return Format
Windows (EXE)	/api/v1/group/<groupid>/installer/windows/exe	ZIP archive containing signed EXE and settings
Windows (MSI)	/api/v1/group/<groupid>/installer/windows/msi	ZIP archive containing signed MSI and settings
macOS (OSX)	/api/v1/group/<groupid>/installer/osx	ZIP archive containing signed PKG and settings
Linux	/api/v1/group/<groupid>/installer/linux	Compressed tarball (.tar.gz) and settings

 

 

Example Procedures

Replace <YOUR_API_TOKEN>, <SERVER_HOST>, and <GROUP_ID> with your environment’s specific details.

1. Download Linux Sensor Tarball

curl -k -X GET -H "X-Auth-Token: <YOUR_API_TOKEN>" "https://<SERVER_HOST>/api/v1/group/<GROUP_ID>/installer/linux" --output cb_linux_group_<GROUP_ID>.tar.gz

2. Download Windows MSI Package

curl -k -X GET -H "X-Auth-Token: <YOUR_API_TOKEN>" "https://<SERVER_HOST>/api/v1/group/<GROUP_ID>/installer/windows/msi" --output cb_windows_group_<GROUP_ID>.zip

Additional Information

• Official API Reference: For further technical specifications, refer to the Carbon Black Developer Network: Download Sensor Installer.
• File Integrity: Ensure the curl command uses the --output flag. If the package fails to extract (e.g., invalid compressed data--format violated), verify that the API response returned a binary file and not a JSON error message.