ZentrixLabs.FalconSdk 1.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package ZentrixLabs.FalconSdk --version 1.0.3
                    
NuGet\Install-Package ZentrixLabs.FalconSdk -Version 1.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ZentrixLabs.FalconSdk" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ZentrixLabs.FalconSdk" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="ZentrixLabs.FalconSdk" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ZentrixLabs.FalconSdk --version 1.0.3
                    
#r "nuget: ZentrixLabs.FalconSdk, 1.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package ZentrixLabs.FalconSdk@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ZentrixLabs.FalconSdk&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=ZentrixLabs.FalconSdk&version=1.0.3
                    
Install as a Cake Tool

ZentrixLabs.FalconSdk

A lightweight, MIT-licensed .NET 9 SDK for querying CrowdStrike Falcon data using their OAuth2 API.

This SDK is designed to simplify local telemetry analysis, patch readiness, and device visibility by abstracting Falcon's token and device API interactions.


โœจ Features

โœ… Supports:

  • OAuth2 token generation from API keys
  • Device query API (/devices/queries/devices/v1)
  • Device detail API (/devices/entities/devices/v2)

๐Ÿšง Not yet implemented:

  • Streaming detections or real-time event subscriptions
  • Threat Graph, incidents, or host group mutations
  • Retry logic or circuit breaker support
  • Built-in structured logging or telemetry

๐Ÿ›  Requirements

You need:

  • A CrowdStrike Falcon API key with the following permissions:
    • Hosts: Read
    • Host Groups: Read

From the Falcon console:

  • Go to Support > API Clients and Keys
  • Create a new key and grant the above permissions

๐Ÿ” Example: Basic Usage

var options = new CrowdStrikeOptions
{
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret"
};

var auth = new CrowdStrikeAuthService(options);
var token = await auth.GetTokenAsync();

var deviceService = new CrowdStrikeDeviceService(auth);
var deviceIds = await deviceService.GetDeviceIdsAsync();
var devices = await deviceService.GetDeviceDetailsAsync(deviceIds);

๐Ÿ“ฆ Install

This project is not yet published to NuGet. To use it locally:

dotnet add package ZentrixLabs.FalconSdk --source ./bin/Release

Or build manually:

dotnet build
dotnet pack -c Release

The .nupkg file will appear in ./bin/Release for local installation.


๐Ÿงช Test Coverage

No unit tests are currently included.
Developers are welcome to add tests using xUnit and reference the SDK as needed.


๐Ÿ“ License

MIT ยฉ ZentrixLabs

Contributions welcome. Open a PR or issue if you find bugs or want to extend support.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.5 81 6/20/2025
1.1.4 78 6/20/2025
1.1.0 77 5/31/2025
1.0.6 153 5/27/2025
1.0.4 100 5/23/2025
1.0.3 94 5/23/2025
1.0.0 101 5/23/2025