Increase Security By Removing Unused API Keys

Overview

It is important to periodically clean up unused API keys to maintain a secure environment. A few instances where we recommend reviewing your API keys include:

  • After updating your integrations using the migration guides
  • When employees with API Keys no longer work at the company
  • When the API Keys are no longer being used - This could be a monthly or quarterly review

Workflow for removing API Keys

  1. In the Carbon Black Cloud console, view the audit log to check if an API key is being used.
    Note: You can also see the user who last retrieved the credentials, so you can confirm with them before removing the key.
  2. If you are still unsure, you can perform a soft check by changing the credentials and searching for API errors. You will receive a 403 Forbidden error on any API calls made with incorrect credentials.
  3. Once you are confident that the API key is unused, you can safely delete it.
Note: If you are removing API keys after updating your integrations and have not yet created your custom key, you can find instructions on creating custom keys in the API Documentation under Authentication.

Guides and Resources


Give Feedback

Use this form to give us feedback about this site or any of the documentation.


Last modified on August 17, 2023