Guide: Set up the CrowdStrike API Client

Peregrine™ works with your individual user CrowdStrike Falcon's API access to grant permissions for changes across your system.

In order to use Peregrine, you will need access to your organization’s CrowdStrike Falcon API, which includes your personalized API Key and Secret Key, provided to you by your CrowdStrike Admin. Peregrine will not enable you to make changes to your CrowdStrike platform via Peregrine, that are not already part of your credential's capabilities.

For a guide for your CrowdStrike admin, please check out our Documentation for Creating a CrowdStrike API Key.

‍

Set up the Client: Adding your CrowdStrike API User Identifications

Under the CrowdStrike API Configuration Section: 

1. Cloud Type: Select the Cloud Used by your tenant
2. Client ID: Enter the CrowdStrike API Key
3. Client Secret: Enter the CrowdStrike API Secret Key
4. Add CID: If you have been provided a specific CID by your organization, select this button to enter your information.
   No CID: If No CID was provided by your organization, select this box to bypass this area.
5. Days Last Seen: Filter your devices by default. We recommend "Last Seen" to show the latest online systems.
6. Group Hosts: Filter your devices by Group Host, if you have multiple hosts setup in future uses of Peregrine on your system.
7. Configuration Name: Add an identifying environment name for the CID - Client CID Name from your CrowdStrike Group Host. This will allow you to more easily identify Group Hosts in the future.
8. Enter a time to keep Log Files in days.
   The retention period is for how long log files are kept on your PC for Peregrine activities. These do not affect anything in CrowdStrike audit logs. We recommend 30 days to start.  
   
9. Leave Debug Mode unchecked.
10. Pull Zero Trust Results: If you would like Zero Trust Results from CrowdStrike pulled in, check this box.
    Note: This may significantly increase load times for large environments.
11. Click Save.  
    Your Credentials will be encrypted and saved for future use in the program.

Repeat this process if you have multiple CIDs to enter.