Usage

Importing the Module

Load PSFalcon before accessing its commands.

Import-Module -Name PSFalcon

Within a script, use a #Requires statement:

#Requires -Version 5.1
using module @{ModuleName='PSFalcon';ModuleVersion='2.2'}

Discovering Commands

View all available commands:

Get-Command -Module PSFalcon

Getting Help

Access documentation for any command:

Get-Help Request-FalconToken
Get-Help Request-FalconToken -Detailed

Key Parameters

Parameter	Purpose
-All	Retrieves all results by handling pagination automatically, rather than just the first page.
-Detailed	Passes identifier values back to retrieve comprehensive information about resources.
-Include	Pulls data from additional APIs and appends it to output. Requires appropriate permissions.
-Total	Returns the result count instead of the results themselves.

Output Conversion

For data export, JSON conversion preserves structure most accurately:

<command> [-Detailed] [-All] | ConvertTo-Json -Depth 16 | Out-File -FilePath .\example.json

The Export-FalconReport cmdlet creates CSV-compatible output for simpler datasets.

Working with Results

Select specific properties

Get-FalconHost -Id $HostId | Select-Object hostname, os_version, agent_version

Filter results

Get-FalconHost -Detailed -All | Where-Object { $_.platform_name -eq 'Windows' }

Group and count

Get-FalconHost -Detailed -All | Group-Object agent_version | Sort-Object Count -Descending

Page Updated: v2.2