Incursa.Platform.HealthProbe 6.0.6

Prefix Reserved

dotnet add package Incursa.Platform.HealthProbe --version 6.0.6

NuGet\Install-Package Incursa.Platform.HealthProbe -Version 6.0.6

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="Incursa.Platform.HealthProbe" Version="6.0.6" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Incursa.Platform.HealthProbe" Version="6.0.6" />
                    

                            Directory.Packages.props

<PackageReference Include="Incursa.Platform.HealthProbe" />
                    

                            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 Incursa.Platform.HealthProbe --version 6.0.6

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Incursa.Platform.HealthProbe, 6.0.6"

#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 Incursa.Platform.HealthProbe@6.0.6

#: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=Incursa.Platform.HealthProbe&version=6.0.6
                    

                            Install as a Cake Addin

#tool nuget:?package=Incursa.Platform.HealthProbe&version=6.0.6
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Incursa.Platform.HealthProbe

Runs health checks with standardized exit codes in either:

inprocess mode: resolve and execute checks from the host DI container.
http mode: call the running app's health endpoints (/healthz, /readyz, /depz by default).

Command

health [live|ready|dep]
health list

Options:

--timeout <seconds>: timeout for the whole execution (default 2s)
--mode <inprocess|http>: override configured mode for this invocation
--json: emit JSON payload
--include-data: include filtered check data entries in output

Default bucket: ready Default mode: inprocess

Exit codes:

0: healthy
1: non-healthy
2: misconfiguration/exception

Configuration

{
  "Incursa": {
    "HealthProbe": {
      "Mode": "http",
      "DefaultBucket": "ready",
      "TimeoutSeconds": 2,
      "Http": {
        "BaseUrl": "http://127.0.0.1:8080",
        "LivePath": "/healthz",
        "ReadyPath": "/readyz",
        "DepPath": "/depz",
        "ApiKey": "replace-me",
        "ApiKeyHeaderName": "X-Api-Key",
        "AllowInsecureTls": false
      }
    }
  }
}

Caller Pattern (No Port Binding In `health` Mode)

Use a dual-builder startup so health invocations never start web hosting:

using Incursa.Platform.HealthProbe;

if (HealthProbeApp.IsHealthCheckInvocation(args))
{
    var hostBuilder = Host.CreateApplicationBuilder(args);
    ConfigureSharedServices(hostBuilder);
    hostBuilder.UseIncursaHealthProbe();

    using var host = hostBuilder.Build();
    return await HealthProbeApp.RunHealthCheckAsync(args, host.Services, CancellationToken.None);
}

var webBuilder = WebApplication.CreateBuilder(args);
ConfigureSharedServices(webBuilder);
webBuilder.UseIncursaHealthProbe();

var app = webBuilder.Build();
app.MapPlatformHealthEndpoints();
await app.RunAsync();

static void ConfigureSharedServices(IHostApplicationBuilder builder)
{
    builder.Services.AddPlatformHealthChecks();
    // register application services used by your health checks
}

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. 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.

net10.0
- Incursa.Platform.Health (>= 6.0.6)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Hosting (>= 10.0.5)
- Microsoft.Extensions.Http (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.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.

Version	Downloads	Last Updated
6.0.6	274	3/13/2026
6.0.3	148	3/10/2026
6.0.1	114	3/10/2026