The Carbon Black App Control API is intended for programmers who want to write code to interact with Carbon Black App Control, either using custom scripts or from other applications. It is a RESTful API that can be consumed over HTTPS protocol using any language that can create get URI requests and post/put JSON requests as well as interpret JSON responses.
Actions performed through the Carbon Black App Control API create an audit trail just as the same action performed from the console would. The appropriate API user taking the action is referenced in event.
The current version of the Carbon Black App Control API is v1. All API calls are based at the following address: https://<your server name> /api/bit9platform/v1.
This section contains the following content:
- API Authentication and Access Control – Describes how to create an API user account and get the API Token necessary for API authentication of clients. It also describes how to configure permissions for the login accounts needed for such access.
- Available Objects – A listing and brief description of the objects you can access through the Carbon Black App Control API.
This section is a summary only. The full API documentation is available in two locations:
- Documentation for the REST API in your version of Carbon Black App Control is available through the console at https://<yourserveraddress>/api/bit9platform/v1.
-
Carbon Black App Control Control REST API documentation can also be found at:
https://developer.carbonblack.com/reference/enterprise-protection.
The following additional resources are available for Carbon Black API developers:
- Carbon Black provides a Python module that developers can use for easy access to the REST APIs for Carbon Black App Control, VMware Carbon Black EDR, and VMware Carbon Black Cloud. The documentation for this module is available at https://cbapi.readthedocs.io.
- The source code for the CB API module (cbapi) for Carbon Black products is located at https://github.com/carbonblack/cbapi-python.
- Tutorials, blogs, and other CB API resources for Carbon Black App Control, Carbon Black EDR, andCarbon Black Cloud are available on the VMware Carbon Black Developer Network site at https://developer.carbonblack.com.
