ASP.NET Core Management Endpoints

• ID: hosting.aspnet-management-endpoints
• Name: ASP.NET Core Management Endpoints
• Maturity: GA
• Summary: Maps authenticated HTTP routes for inbox, outbox, processor control, retention, and host diagnostics.

What It Does

AddLiteBusManagementEndpoints maps operator routes under a configurable prefix. The default prefix is litebus. Inbox and outbox route groups are enabled independently based on the managers registered by each durable module.

The endpoints expose manager and processor-control contracts. They do not read store implementation details or broker SDK types, so an in-memory, PostgreSQL, or custom store presents the same HTTP model.

services.AddLiteBusManagement(options =>
{
    options.RoutePrefix = "operations/litebus";
    options.AuthorizationPolicy = "LiteBusOperator";
});

app.AddLiteBusManagementEndpoints();

Hosts that map through IEndpointRouteBuilder can call AddLiteBusManagementEndpoints directly. Leading and trailing slashes on RoutePrefix are removed before route templates are built.

Public Surface

Routes

The table uses the default litebus prefix. Outbox routes mirror inbox routes with /outbox in place of /inbox.

Authorization and Safety

Management routes require an authenticated caller by default. When AuthorizationPolicy contains a policy name, every route requires that policy. Set AllowAnonymousManagement only for a host whose network boundary already limits access, such as an isolated local test host. Query, bulk identifier, and drain limits are validated before manager calls so operator traffic cannot request unbounded store work.

Unrestricted purge requests require a JSON body with confirm set to true. Narrowed purge requests can omit confirmation because their query predicates limit the target set. Manager safety exceptions become HTTP 400 responses; unexpected manager failures become HTTP 500 problem responses.

When an inbox or outbox manager is absent, the entire matching route group returns HTTP 404 with an axis-specific message. Processor routes return HTTP 404 when the manager exists but the matching processor control is not registered.

Packages

• LiteBus.Extensions.AspNetCore

Requires

• LiteBus.Extensions.Microsoft.DependencyInjection
• IInboxManager for inbox routes
• IOutboxManager for outbox routes
• IInboxProcessorControl or IOutboxProcessorControl for processor routes
• LiteBusHostManifest for /health
• ASP.NET Core authentication and authorization unless anonymous management is explicitly enabled

Observability

The health route returns each diagnostic check's name, status, description, and data. It returns HTTP 200 only when the aggregate result is healthy. Degraded or unhealthy results return HTTP 503.

Management routes do not define a separate meter. Use LiteBus.Inbox and LiteBus.Outbox metrics for queue depth, processor state, pass outcomes, and retention operations. ASP.NET Core request telemetry records HTTP duration and status at the host boundary.

Invariants

• Inbox and outbox route groups remain independent.
• Storage adapters remain behind manager interfaces.
• Destructive operations retain confirmation and authorization guards.
• Drain timeout query values must be positive; missing or non-positive values use DefaultDrainTimeout, and values above MaxDrainTimeout are rejected.
• Query page sizes cannot exceed MaxPageSize.
• Requeue and purge identifier lists cannot exceed MaxBulkMessageIds.
• Route prefix trimming never creates consecutive slashes.

Non-Goals

• Authentication provider or token configuration.
• Audit log storage.
• Rate limiting and abuse protection.
• Cross-cluster processor coordination.
• Direct transport consumer controls.

Test Coverage

Covered Use Cases

Untested Use Cases

• HTTP 500 problem response content from an unexpected manager exception.
• HTTP 404 responses for processor routes when an axis manager exists without a processor control.

Out-of-Scope Use Cases

• Identity provider integration.
• Operator audit persistence.
• Multi-cluster management federation.

Deep Docs

• Operations and Management
• Hosted Services
• Diagnostics and Health