ZentrixLabs.FalconSdk
1.0.3
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
<PackageReference Include="ZentrixLabs.FalconSdk" Version="1.0.3" />
<PackageVersion Include="ZentrixLabs.FalconSdk" Version="1.0.3" />
<PackageReference Include="ZentrixLabs.FalconSdk" />
paket add ZentrixLabs.FalconSdk --version 1.0.3
#r "nuget: ZentrixLabs.FalconSdk, 1.0.3"
#:package ZentrixLabs.FalconSdk@1.0.3
#addin nuget:?package=ZentrixLabs.FalconSdk&version=1.0.3
#tool nuget:?package=ZentrixLabs.FalconSdk&version=1.0.3
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 | Versions 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. |
-
net9.0
- Microsoft.Extensions.DependencyInjection (>= 9.0.5)
- Microsoft.Extensions.Http (>= 9.0.5)
- Microsoft.Extensions.Options (>= 9.0.5)
- System.Text.Json (>= 9.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.