Installation

Prerequisites

Before installing PSFalcon, verify your environment meets these requirements:

PowerShell Version

Check your PowerShell version:

$PSVersionTable.PSVersion

Required versions:

Windows: PowerShell 5.1 or later
Linux/macOS: PowerShell 6 or later

Internet Connectivity

Ensure you have internet access to download from the PowerShell Gallery and connect to CrowdStrike Falcon APIs

API Client Credentials

Create an OAuth2 API client in your Falcon console:

Navigate to Support and resources > API Clients and Keys
Click Add new API client
Provide a name and description
Select the appropriate API scopes (minimum: Hosts: Read)
Save your Client ID and Client Secret (shown only once)

Store your API credentials securely. The Client Secret is only displayed once during creation. If lost, you must create a new API client.

Install from PowerShell Gallery

PSFalcon is published to the PowerShell Gallery, making installation straightforward.

Install for Current User

Recommended for most users (no administrator/root privileges required):

Install-Module -Name PSFalcon -Scope CurrentUser

Install for All Users

Requires administrator privileges on Windows or root on Linux/macOS:

Install-Module -Name PSFalcon -Scope AllUsers

sudo pwsh -Command "Install-Module -Name PSFalcon -Scope AllUsers"

Install Specific Version

To install a specific version of PSFalcon:

Install-Module -Name PSFalcon -RequiredVersion 2.2.9 -Scope CurrentUser

Verify Installation

Confirm PSFalcon is installed correctly:

Get-Module -Name PSFalcon -ListAvailable

Expected output:

ModuleType Version    Name           ExportedCommands
---------- -------    ----           ----------------
Script     2.2.9      PSFalcon       {Add-FalconGroupingTag, Add-FalconRole, ...}

Import the Module

Load PSFalcon into your PowerShell session:

Import-Module -Name PSFalcon

PowerShell automatically imports modules when you use their cmdlets, so explicit import is optional. However, explicit import can help verify the module loads without errors.

Update PSFalcon

Keep PSFalcon up to date to access new features and bug fixes:

Update-Module -Name PSFalcon

Check for available updates:

# Get installed version
$Installed = (Get-Module -Name PSFalcon -ListAvailable).Version

# Get latest version from PowerShell Gallery
$Latest = (Find-Module -Name PSFalcon).Version

if ($Latest -gt $Installed) {
    Write-Host "Update available: $Installed -> $Latest"
} else {
    Write-Host "PSFalcon is up to date: $Installed"
}

Uninstall PSFalcon

If needed, remove PSFalcon from your system:

Uninstall-Module -Name PSFalcon

To remove all versions:

Uninstall-Module -Name PSFalcon -AllVersions

Troubleshooting

Installation fails with 'Unable to download from URI'

Issue: Cannot connect to PowerShell GallerySolutions:

Check internet connectivity
Verify proxy settings if behind a corporate firewall

Ensure TLS 1.2 is enabled:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

'Install-Module' is not recognized

Issue: PowerShellGet module is not availableSolution: Update to PowerShell 5.1 or later, or install PowerShellGet:

Install-Module -Name PowerShellGet -Force

Module fails to import

Issue: Import-Module returns errorsSolutions:

Verify .NET Framework 4.5+ is installed (Windows)

Check execution policy:

Get-ExecutionPolicy
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Review error messages for missing dependencies

'PSFalcon' module not found after installation

Issue: Module installed but not detectedSolution: Check module path:

$env:PSModulePath -split [IO.Path]::PathSeparator

Ensure PSFalcon is in one of these directories.

Offline Installation

For environments without internet access:

Download on Connected System

On a system with internet access:

Save-Module -Name PSFalcon -Path C:\Temp\PSFalcon

Transfer Files

Copy the downloaded module folder to your offline system

Install on Offline System

Place the module in your PowerShell module path:Windows:

Copy-Item -Path "C:\Temp\PSFalcon\PSFalcon" -Destination "$env:ProgramFiles\WindowsPowerShell\Modules\" -Recurse

Linux/macOS:

cp -r /tmp/PSFalcon/PSFalcon ~/.local/share/powershell/Modules/

Verify Installation

Import-Module PSFalcon
Get-Module PSFalcon

Configuration

PSFalcon uses System.Net.Http for API requests and automatically configures TLS 1.2.

Required Assemblies

System.Net.Http (automatically loaded)

Supported Clouds

PSFalcon supports all CrowdStrike cloud regions:

Cloud	Region	Hostname
us-1	US Commercial 1	`https://api.crowdstrike.com`
us-2	US Commercial 2	`https://api.us-2.crowdstrike.com`
eu-1	EU	`https://api.eu-1.crowdstrike.com`
us-gov-1	US GovCloud 1	`https://api.laggar.gcw.crowdstrike.com`
us-gov-2	US GovCloud 2	`https://api.us-gov-2.crowdstrike.mil`

PSFalcon automatically handles cloud redirects. If you authenticate to the wrong cloud, the module will redirect you to the correct region based on your API client.

Next Steps

Quick Start Guide

Learn how to authenticate and run your first PSFalcon commands

Get Started

Core Concepts

Guides

Prerequisites

Install from PowerShell Gallery

Install for Current User

Install for All Users

Install Specific Version

Verify Installation

Import the Module

Update PSFalcon

Uninstall PSFalcon

Troubleshooting

Offline Installation

Configuration

Required Assemblies

Supported Clouds

Next Steps

Quick Start Guide

​Prerequisites

​Install from PowerShell Gallery

​Install for Current User

​Install for All Users

​Install Specific Version

​Verify Installation

​Import the Module

​Update PSFalcon

​Uninstall PSFalcon

​Troubleshooting

​Offline Installation

​Configuration

​Required Assemblies

​Supported Clouds

​Next Steps

Quick Start Guide

Prerequisites

Install from PowerShell Gallery

Install for Current User

Install for All Users

Install Specific Version

Verify Installation

Import the Module

Update PSFalcon

Uninstall PSFalcon

Troubleshooting

Offline Installation

Configuration

Required Assemblies

Supported Clouds

Next Steps