Carbon Black Cloud: How to Download Sensor Kits Via the API
search cancel

Carbon Black Cloud: How to Download Sensor Kits Via the API


Article ID: 288390


Updated On:


Carbon Black Cloud Endpoint Standard (formerly Cb Defense) Carbon Black Cloud Enterprise EDR (formerly Cb Threathunter)


To download sensor kits via the API


  • Carbon Black Cloud Console: All Versions


  1. Create API Key
    1. Log into Console
    2. Go to Settings > API Access > Access Levels
    3. Click "Add Access Level"
    4. Enter name and description
    5. Check the  "Device- Sensor kits -org.kits - execute" permission
    6. Save
    7. Navigate to API Keys tab
    8. Note the "Org ID"
    9. Click 'Add API Key' button
    10. Enter name and description
    11. Under "Access Level type" choose Custom > Select access level made in steps 2-6.
    12. Click 'Save'
    13. Copy API credentials displayed (<API_ID>, <API_Secret_Key> below)
  2. Export Admin Users
    1. Log into machine able to run cURL
    2. Run API call to export the data
      curl --location --request GET "<org id>/kits/installer_vista_win7_win8-64-" --proxy http://<username>:<password>@<proxy>:<proxyport> -H "X-Auth-Token:<secret key>/<api id>" --output c:\temp\
    3. Save data to file as desired

Additional Information

  • Example above would download the Windows sensor. Edit the version # to download a different kit
  • Mac url format:
  • Linux url format:
  • The API above is an unofficial and unsupported API which is used to populate information for the Console UI and is not supported for use as a standalone API
  • Being an unsupported API means the specified route/endpoint could be changed at any point and without notice