By clicking “Accept”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.
Guide: Getting Your Organization Started with Peregrine™
7 minutes
Peregrine™ is a powerful native application to optimize the functions of CrowdStrike Falcon on your local machine. Peregrine is available for download and this guide will help you and your organization get up and running quickly.
Prerequisites
CrowdStrike Falcon API Access: Peregrine works with your individual user 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. For a guide for your CrowdStrike admin, please check out our Documentation for Creating a CrowdStrike API Key.
Operating Systems: Currently Peregrine works on Windows and MacOS*. Note that for MacOS, we ware still working to get the app certified into the Apple Marketplace. Until then, when you install the file, it will say it is unsigned.
Activating Peregrine™ for your organization on a Paid Account
All Peregrine accounts require an organization account, with an invitation key, to be setup first. That Organization Account will then administer Seat Activation Keys to that organization's account. If this is your organization's first time activating Peregrine, you will need both an Invitation Key (for portal access), and a Seat Activation key to activate your Peregrine desktop app. Seats within an organization allow for a consolidation of endpoint counts, so your organization is not billed more than once for endpoints within your environment(s). We do not charge per seat with Peregrine, so be sure to create keys for each seat in your organization that you would like to have access to Peregrine.
Obtaining an activation key to Create your Peregrine Portal Account:
Save the file to the location on your system where you want the program to live. With Peregrine there are no install requirements, the program is ready to run right after you download it.
Run/Open the Peregrine Application The First time you run the program a folder will be created in the same location as the executable file. This folder will save your encrypted files for use with Peregrine.
Enter your Seat Activation Key in the License key field provided within the Peregrine desktop application.
Click Activate to activate Peregrine.
Set up the Client: Adding your CrowdStrike API User Identifications
Under the CrowdStrike API Configuration Section:
Cloud Type: Select the Cloud Used by your tenant
Client ID: Enter the CrowdStrike API Key
Client Secret: Enter the CrowdStrike API Secret Key
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.
Days Last Seen: Filter your devices by default. We recommend "Last Seen" to show the latest online systems.
Group Hosts: Filter your devices by Group Host, if you have multiple hosts setup in future uses of Peregrine on your system.
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.
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.
Leave Debug Mode unchecked.
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.
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.
Congratulations!
You are up and running! Be sure to check-in over on our Discord Channel to connect with the peregrine Community with any questions, for tips and to share scripts and ideas for improving the platform! We look forward to hearing all about your experience with Peregrine! Welcome aboard!