Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Home
PowerShell
Tutorials
Introduction
Hello World
Routes
Multiple Content Types
Multi-language Routes (PS/C#/VB)
Route Parameters & Request Data
Route Options (MapRouteOptions)
Route Groups
Static Routes
Serving Static Files
File Server & Directory Browsing
Static Route Overrides
Adding a Favicon
File Server Caching Headers
Response Caching & Conditional Requests
Shared Variable
Using Shared Variables
Managing Shared State
Shared State Snapshots
Logging
Simple Logging
Multiple Loggers & Levels
Enrichment & Correlation IDs
Sinks (Console/File/JSON)
Sinks (HTTP/EventLog/Syslog)
Hot Reload (Update Logger)
Apache Common Access Log
Certificates
Create a Self‑Signed Certificate
Generate a CSR (Certificate Signing Request)
Import, Export, Validate & EKU
Endpoints
Basic Server
Multiple Listeners
HTTPS & Certificates
Named Pipes (Windows)
Unix Sockets
Mixed HTTP Protocols
URI Endpoint
Authentication
Basic (PowerShell)
Basic (C# / VB.NET)
API Key
JWT Tokens
Cookies
Windows Authentication
Claims & Policies
Client Certificate
OpenID Connect (Okta)
Multiple Schemes
GitHub Authentication
Full Demo
OpenID Connect (Duende Demo)
Full Demo
Responses
Text & JSON
Structured (XML / YAML / CSV)
Binary & Stream
HTML Templates & Files
Special Formats (BSON / CBOR)
Redirects
Errors
Caching & Revalidation
Content Negotiation
Low-Level Response Stream
OpenApi
Hello World
Component Schemas
RequestBody Components
Parameter Components
Response Components
Complete Components
Tags and External Docs
Document Information
Component Headers
Component Links
Component Callbacks
WebHooks
Examples
Swagger Petstore
Redocly Museum API
Multiple OpenAPI Documents
Product Search with HTTP QUERY (OpenAPI 3.2)
SSE (OpenAPI)
SSE Broadcast (OpenAPI)
SignalR (OpenAPI)
XML Modeling
RFC 6570 Variable Mapping
Additional and Pattern Properties
Custom Error Handler
Scheduler
Scheduling Quickstart
Scheduling with CRON
Scheduling Report
Razor
Razor Pages Quickstart
Razor Pages with Antiforgery
Pages
Index
About
Status
Quotes
Contact
AppInfo
Cancel
Shared Layout
ViewStart
ViewImports
Server Configuration
Server Limits
Server Options
Lifecycle
Start/Stop Patterns
Full Server Demo
Middleware
Antiforgery Protection
Response Compression
HTTPS Redirection
SignalR
Host Filtering
Forwarded Headers
CORS
SSE
SSE Broadcast
Request Decompression
Health
Health Quickstart
Script Probe
HTTP Probe
Process Probe
C# Inline Probe
Disk Probe
Health Response Format
Status Code Pages
Default Status Code Pages
Custom Options
Custom Handler (PowerShell)
Custom Handler (C# Inline)
Content Format
Redirects
Re-execute
Common Status Codes
Exception Handling
Exception Handling Path
VB.NET Handler
C# Inline Handler
ProblemDetails Fallback
Developer Exception Page
Sessions
Basic Sessions
Sessions with Redis
Sessions with SQL Server
Tasks
Basic Tasks
Localization
∞
Razor Localization
File and Form Uploads
Basic multipart/form-data upload
Multiple files (same field name)
application/x-www-form-urlencoded forms
multipart/mixed ordered parts
Nested multipart/mixed
Request-level compression
Part-level compression
OpenAPI: basic multipart upload
OpenAPI: multiple files
OpenAPI: urlencoded forms
OpenAPI: multipart/mixed
OpenAPI: nested multipart
OpenAPI: request-level compression
OpenAPI: part-level compression
OpenAPI: file hash upload
Form rules: file hash upload
Applications
Bike Rental Shop Application
Bike Rental Shop Web Client
Bike Rental Shop Backend Variants
Bike Rental Shop Packaging
Bike Rental Shop Install and Update
PowerShell Cmdlets
Add-KrAddCallbacksAutomation
Add-KrAntiforgeryMiddleware
Add-KrAntiforgeryTokenRoute
Add-KrApiDocumentationRoute
Add-KrApiKeyAuthentication
Add-KrBasicAuthentication
Add-KrCacheMiddleware
Add-KrCacheResponse
Add-KrClaimPolicy
Add-KrClientCertificateAuthentication
Add-KrCommonAccessLogMiddleware
Add-KrCompressionMiddleware
Add-KrCookiesAuthentication
Add-KrCorsPolicy
Add-KrDistributedRedisCache
Add-KrDistributedSqlServerCache
Add-KrEndpoint
Add-KrEnrichEnvironment
Add-KrEnrichErrorRecord
Add-KrEnrichExceptionDetail
Add-KrEnrichFromLogContext
Add-KrEnrichProcessId
Add-KrEnrichProcessName
Add-KrEnrichProperty
Add-KrFaviconMiddleware
Add-KrFileServerMiddleware
Add-KrFormOption
Add-KrFormRoute
Add-KrForwardedHeader
Add-KrGitHubAuthentication
Add-KrHealthEndpoint
Add-KrHealthHttpProbe
Add-KrHealthProbe
Add-KrHealthProcessProbe
Add-KrHostFiltering
Add-KrHsts
Add-KrHtmlTemplateRoute
Add-KrHttpsRedirection
Add-KrJWTAudience
Add-KrJWTBearerAuthentication
Add-KrJWTClaim
Add-KrJWTHeader
Add-KrJWTIssuer
Add-KrJWTSubject
Add-KrListenUnixSocket
Add-KrLocalizationMiddleware
Add-KrMapRoute
Add-KrNamedPipeListener
Add-KrOAuth2Authentication
Add-KrOpenApiComponent
Add-KrOpenApiContact
Add-KrOpenApiExtension
Add-KrOpenApiExternalDoc
Add-KrOpenApiInfo
Add-KrOpenApiInline
Add-KrOpenApiLicense
Add-KrOpenApiRoute
Add-KrOpenApiServer
Add-KrOpenApiTag
Add-KrOpenIdConnectAuthentication
Add-KrPowerShellRazorPagesRuntime
Add-KrRazorPageService
Add-KrRequestDecompressionMiddleware
Add-KrRouteGroup
Add-KrScheduling
Add-KrScriptBlock
Add-KrSession
Add-KrSignalRHubMiddleware
Add-KrSinkConsole
Add-KrSinkEventLog
Add-KrSinkFile
Add-KrSinkHttp
Add-KrSinkPowerShell
Add-KrSinkSyslogLocal
Add-KrSinkSyslogTcp
Add-KrSinkSyslogUdp
Add-KrSseBroadcastMiddleware
Add-KrStaticFilesMiddleware
Add-KrTasksService
Add-KrUserClaim
Add-KrWindowsAuthentication
Build-KrClaimPolicy
Build-KrJWT
Build-KrOpenApiDocument
Clear-KrEnvironmentOverride
Clear-KrSession
Close-KrLogger
ConvertFrom-KrJwkJsonToCertificate
ConvertFrom-KrYaml
ConvertTo-KrBase64Url
ConvertTo-KrJwkJson
ConvertTo-KrYaml
Copy-KrJWTTokenBuilder
Enable-KrConfiguration
Enable-KrExceptionHandling
Enable-KrStatusCodePage
Expand-KrObject
Export-KrCertificate
Export-KrOpenApiDocument
Export-KrSharedState
Get-KrBuiltTargetFrameworkVersion
Get-KrCertificatePurpose
Get-KrDefaultLogger
Get-KrEnvironment
Get-KrFeatureSupport
Get-KrFormOption
Get-KrFormPartRule
Get-KrJwkThumbprint
Get-KrJWTInfo
Get-KrJWTToken
Get-KrJWTValidationParameter
Get-KrLocalizationCulture
Get-KrLocalizedString
Get-KrLock
Get-KrLoggerLevelSwitch
Get-KrOpenApiDocument
Get-KrRequestBody
Get-KrRequestCookie
Get-KrRequestForm
Get-KrRequestHeader
Get-KrRequestQuery
Get-KrRequestRouteParam
Get-KrRoot
Get-KrScheduleReport
Get-KrScheduleSnapshot
Get-KrServer
Get-KrServiceDescriptor
Get-KrSessionByte
Get-KrSessionInt32
Get-KrSessionString
Get-KrSharedState
Get-KrSignalRConnectedClient
Get-KrSinkJsonFormatter
Get-KrSseConnectedClientCount
Get-KrTask
Get-KrTaskResult
Get-KrTaskState
Get-KrVersion
Import-KrCertificate
Import-KrSharedState
Initialize-KrRoot
Invoke-KrChallenge
Invoke-KrCookieSignIn
Invoke-KrCookieSignOut
Invoke-KrWebRequest
Kestrun
Limit-KrJWTNotBefore
Limit-KrJWTValidity
New-KrCertificateRequest
New-KrClaimPolicy
New-KrCookieBuilder
New-KrCorsPolicyBuilder
New-KrDockerDeployment
New-KrFormPartRule
New-KrJWTBuilder
New-KrLogger
New-KrMapRouteOption
New-KrOpenApiExample
New-KrOpenApiExternalDoc
New-KrOpenApiHeader
New-KrOpenApiLink
New-KrOpenApiServer
New-KrOpenApiServerVariable
New-KrPrivateKeyJwt
New-KrProbeResult
New-KrSelfSignedCertificate
New-KrServer
New-KrServiceDescriptor
New-KrServicePackage
New-KrTask
NoDefault
Protect-KrJWT
Protect-KrJWTPayload
Push-KrLogContextProperty
Register-KrLogger
Register-KrSchedule
Remove-KrServer
Remove-KrSession
Remove-KrSharedState
Remove-KrTask
Resolve-KrPath
Resume-KrSchedule
Send-KrSignalREvent
Send-KrSignalRGroupMessage
Send-KrSignalRLog
Send-KrSseBroadcastEvent
Set-KrCorsCredential
Set-KrCorsExposedHeader
Set-KrCorsHeader
Set-KrCorsMethod
Set-KrCorsOrigin
Set-KrCorsPreflightMaxAge
Set-KrDefaultLogger
Set-KrEnvironment
Set-KrLoggerLevel
Set-KrLoggerLevelSwitch
Set-KrOpenApiErrorSchema
Set-KrPowerShellErrorResponse
Set-KrPythonRuntime
Set-KrServerHttpsOptions
Set-KrServerLimit
Set-KrServerNamedPipeOptions
Set-KrServerOptions
Set-KrServiceDescriptor
Set-KrSessionByte
Set-KrSessionInt32
Set-KrSessionString
Set-KrSharedState
Set-KrTaskName
Start-KrServer
Start-KrSseResponse
Start-KrTask
Stop-KrServer
Stop-KrTask
Suspend-KrSchedule
Test-KrCacheRevalidation
Test-KrCapability
Test-KrCertificate
Test-KrDebugContext
Test-KrJWT
Test-KrLogger
Test-KrOpenApiDocument
Test-KrRoute
Update-KrJWT
Update-KrSynchronizedCounter
Use-KrLock
Write-KrBinaryResponse
Write-KrBsonResponse
Write-KrCborResponse
Write-KrCsvResponse
Write-KrErrorResponse
Write-KrFileResponse
Write-KrFormUrlEncodedResponse
Write-KrHtmlResponse
Write-KrJsonResponse
Write-KrLog
Write-KrRedirectResponse
Write-KrResponse
Write-KrSseEvent
Write-KrStatusResponse
Write-KrStreamResponse
Write-KrTextResponse
Write-KrXmlResponse
Write-KrYamlResponse
C#
C# API
Kestrun
FixedTimeEquals class
FixedTimeEquals.Test method (1 of 7)
KestrunHostManager class
KestrunHostManager.Contains method
KestrunHostManager.Create method (1 of 3)
KestrunHostManager.Default property
KestrunHostManager.Destroy method
KestrunHostManager.DestroyAll method
KestrunHostManager.EntryScriptPath property
KestrunHostManager.Get method
KestrunHostManager.InstanceNames property
KestrunHostManager.IsRunning method
KestrunHostManager.KestrunRoot property
KestrunHostManager.SetDefault method
KestrunHostManager.StartAsync method
KestrunHostManager.Stop method
KestrunHostManager.StopAllAsync method
KestrunHostManager.StopAsync method
KestrunHostManager.TryGet method
KestrunRuntimeInfo class
KestrunRuntimeInfo.AspNetCoreVersion property
KestrunRuntimeInfo.GetBuiltTargetFrameworkName method
KestrunRuntimeInfo.GetBuiltTargetFrameworkVersion method
KestrunRuntimeInfo.GetKnownFeatures method
KestrunRuntimeInfo.IsDebugBuild property
KestrunRuntimeInfo.IsReleaseDistribution property
KestrunRuntimeInfo.KestrunRoot property
KestrunRuntimeInfo.KnownFeature enumeration
KestrunRuntimeInfo.Supports method (1 of 2)
KestrunRuntimeInfo.TryGetMinVersion method
Kestrun.Authentication
ApiKeyAuthenticationOptions class
ApiKeyAuthenticationOptions constructor
ApiKeyAuthenticationOptions.AdditionalHeaderNames property
ApiKeyAuthenticationOptions.AllowInsecureHttp property
ApiKeyAuthenticationOptions.AllowQueryStringFallback property
ApiKeyAuthenticationOptions.ApiKeyName property
ApiKeyAuthenticationOptions.ApplyTo method
ApiKeyAuthenticationOptions.ChallengeHeaderFormat property
ApiKeyAuthenticationOptions.ClaimPolicyConfig property
ApiKeyAuthenticationOptions.Deprecated property
ApiKeyAuthenticationOptions.Description property
ApiKeyAuthenticationOptions.DisplayName property
ApiKeyAuthenticationOptions.DocumentationId property
ApiKeyAuthenticationOptions.EmitChallengeHeader property
ApiKeyAuthenticationOptions.GlobalScheme property
ApiKeyAuthenticationOptions.Host property
ApiKeyAuthenticationOptions.In property
ApiKeyAuthenticationOptions.IssueClaims property
ApiKeyAuthenticationOptions.IssueClaimsCodeSettings property
ApiKeyAuthenticationOptions.Logger property
ApiKeyAuthenticationOptions.StaticApiKey property
ApiKeyAuthenticationOptions.StaticApiKeyAsBytes property
ApiKeyAuthenticationOptions.ValidateCodeSettings property
ApiKeyAuthenticationOptions.ValidateKeyAsync property
ApiKeyAuthHandler class
ApiKeyAuthHandler constructor
ApiKeyAuthHandler.BuildCsValidator method
ApiKeyAuthHandler.BuildPsValidator method
ApiKeyAuthHandler.BuildVBNetValidator method
ApiKeyAuthHandler.Host property
ApiKeyChallengeFormat enumeration
AssertionService class
AssertionService constructor
AssertionService.ClientId property
AssertionService.CreateClientAssertion method
AuthenticationCodeSettings constructor
AuthenticationCodeSettings record
AuthenticationCodeSettings.Code property
AuthenticationCodeSettings.CSharpVersion property
AuthenticationCodeSettings.ExtraImports property
AuthenticationCodeSettings.ExtraRefs property
AuthenticationCodeSettings.Language property
AuthenticationCodeSettings.VisualBasicVersion property
AuthenticationDefaults class
AuthenticationDefaults.ApiKeyDisplayName field
AuthenticationDefaults.ApiKeySchemeName field
AuthenticationDefaults.BasicDisplayName field
AuthenticationDefaults.BasicSchemeName field
AuthenticationDefaults.BearerDisplayName field
AuthenticationDefaults.BearerSchemeName field
AuthenticationDefaults.CertificateDisplayName field
AuthenticationDefaults.CertificateSchemeName field
AuthenticationDefaults.CookiesDisplayName field
AuthenticationDefaults.CookiesSchemeName field
AuthenticationDefaults.DigestDisplayName field
AuthenticationDefaults.DigestSchemeName field
AuthenticationDefaults.GitHubDisplayName field
AuthenticationDefaults.GitHubSchemeName field
AuthenticationDefaults.JwtBearerDisplayName field
AuthenticationDefaults.JwtBearerSchemeName field
AuthenticationDefaults.NtLmDisplayName field
AuthenticationDefaults.NtLmSchemeName field
AuthenticationDefaults.OAuth2DisplayName field
AuthenticationDefaults.OAuth2SchemeName field
AuthenticationDefaults.OidcDisplayName field
AuthenticationDefaults.OidcSchemeName field
AuthenticationDefaults.WindowsDisplayName field
AuthenticationDefaults.WindowsSchemeName field
AuthenticationRegistry class
AuthenticationRegistry constructor
AuthenticationRegistry.Clear method
AuthenticationRegistry.Exists method
AuthenticationRegistry.Get method (1 of 2)
AuthenticationRegistry.GetClaimPolicyConfigs method
AuthenticationRegistry.GetOidcOptions method
AuthenticationRegistry.GetSchemesByPolicy method
AuthenticationRegistry.Items method
AuthenticationRegistry.Register method (1 of 2)
AuthenticationRegistry.Remove method
AuthenticationRegistry.ResolveAuthenticationSchemeName method
AuthenticationRegistry.TryGet method (1 of 2)
AuthenticationRegistry.Upsert method (1 of 2)
AuthenticationType enumeration
AuthOptionsHelper class
AuthOptionsHelper.GetAuthOptions<TOptions> method
BasicAuthenticationOptions class
BasicAuthenticationOptions constructor
BasicAuthenticationOptions.AllowInsecureHttp property
BasicAuthenticationOptions.ApplyTo method
BasicAuthenticationOptions.Base64Encoded property
BasicAuthenticationOptions.ClaimPolicyConfig property
BasicAuthenticationOptions.Deprecated property
BasicAuthenticationOptions.Description property
BasicAuthenticationOptions.DisplayName property
BasicAuthenticationOptions.DocumentationId property
BasicAuthenticationOptions.GlobalScheme property
BasicAuthenticationOptions.HeaderName property
BasicAuthenticationOptions.Host property
BasicAuthenticationOptions.IssueClaims property
BasicAuthenticationOptions.IssueClaimsCodeSettings property
BasicAuthenticationOptions.Logger property
BasicAuthenticationOptions.Realm property
BasicAuthenticationOptions.SeparatorRegex property
BasicAuthenticationOptions.SuppressWwwAuthenticate property
BasicAuthenticationOptions.ValidateCodeSettings property
BasicAuthenticationOptions.ValidateCredentialsAsync property
BasicAuthHandler class
BasicAuthHandler constructor
BasicAuthHandler.BuildCsValidator method
BasicAuthHandler.BuildPsValidator method
BasicAuthHandler.BuildVBNetValidator method
BasicAuthHandler.Host property
ClientCertificateAuthenticationOptions class
ClientCertificateAuthenticationOptions constructor
ClientCertificateAuthenticationOptions.ApplyTo method
ClientCertificateAuthenticationOptions.Deprecated property
ClientCertificateAuthenticationOptions.Description property
ClientCertificateAuthenticationOptions.DisplayName property
ClientCertificateAuthenticationOptions.DocumentationId property
ClientCertificateAuthenticationOptions.GlobalScheme property
ClientCertificateAuthenticationOptions.Host property
ClientCertificateAuthenticationOptions.Logger property
ClientCertificateAuthHandler class
ClientCertificateAuthHandler constructor
ClientCertificateAuthHandler.Host property
CookieAuthOptions class
CookieAuthOptions constructor
CookieAuthOptions.AllowInsecureHttp property
CookieAuthOptions.ApplyTo method (1 of 2)
CookieAuthOptions.Deprecated property
CookieAuthOptions.Description property
CookieAuthOptions.DisplayName property
CookieAuthOptions.DocumentationId property
CookieAuthOptions.GlobalScheme property
CookieAuthOptions.Host property
CookieAuthOptions.Logger property
IAuthenticationCommonOptions interface
IAuthenticationCommonOptions.ValidateCodeSettings property
IAuthenticationHostOptions interface
IAuthenticationHostOptions.DisplayName property
IAuthenticationHostOptions.Host property
IAuthenticationHostOptions.Logger property
IAuthHandler interface
IAuthHandler.BuildCsIssueClaims method
IAuthHandler.BuildPsIssueClaims method
IAuthHandler.BuildVBNetIssueClaims method
IAuthHandler.GetAuthenticationTicketAsync method
IAuthHandler.IssueClaimsPowerShellAsync method
IAuthHandler.ValidatePowerShellAsync method
IClaimsCommonOptions interface
IClaimsCommonOptions.ClaimPolicyConfig property
IClaimsCommonOptions.IssueClaims property
IClaimsCommonOptions.IssueClaimsCodeSettings property
IOpenApiAuthenticationOptions interface
IOpenApiAuthenticationOptions.DefaultSchemeName field
IOpenApiAuthenticationOptions.Deprecated property
IOpenApiAuthenticationOptions.Description property
IOpenApiAuthenticationOptions.DocumentationId property
IOpenApiAuthenticationOptions.GlobalScheme property
JwtAuthOptions class
JwtAuthOptions constructor
JwtAuthOptions.AllowInsecureHttp property
JwtAuthOptions.ApplyTo method (1 of 2)
JwtAuthOptions.ClaimPolicy property
JwtAuthOptions.ClaimPolicyConfig property
JwtAuthOptions.Deprecated property
JwtAuthOptions.Description property
JwtAuthOptions.DisplayName property
JwtAuthOptions.DocumentationId property
JwtAuthOptions.GlobalScheme property
JwtAuthOptions.Host property
JwtAuthOptions.IssueClaims property
JwtAuthOptions.IssueClaimsCodeSettings property
JwtAuthOptions.Logger property
JwtAuthOptions.ValidationParameters property
OAuth2Options class
OAuth2Options constructor
OAuth2Options.AllowInsecureMetadataHttp property
OAuth2Options.ApplyTo method (1 of 2)
OAuth2Options.AuthenticationScheme property
OAuth2Options.ClaimPolicy property
OAuth2Options.CookieOptions property
OAuth2Options.CookieScheme property
OAuth2Options.Deprecated property
OAuth2Options.Description property
OAuth2Options.DisplayName property
OAuth2Options.DocumentationId property
OAuth2Options.GlobalScheme property
OAuth2Options.Host property
OAuth2Options.Logger property
OAuth2Options.OAuth2MetadataUrl property
OAuth2Options.ResolveEndpointsFromMetadata property
OidcEvents class
OidcEvents constructor
OidcEvents.AuthorizationCodeReceived method
OidcOptions class
OidcOptions constructor
OidcOptions.ApplyTo method (1 of 2)
OidcOptions.AuthenticationScheme property
OidcOptions.ClaimPolicy property
OidcOptions.CookieOptions property
OidcOptions.CookieScheme property
OidcOptions.Deprecated property
OidcOptions.Description property
OidcOptions.DisplayName property
OidcOptions.DocumentationId property
OidcOptions.GlobalScheme property
OidcOptions.Host property
OidcOptions.JwkJson property
OidcOptions.Logger property
OidcOptions.PushedAuthorizationBehavior property
WindowsAuthOptions class
WindowsAuthOptions constructor
WindowsAuthOptions.ApplyTo method (1 of 2)
WindowsAuthOptions.Deprecated property
WindowsAuthOptions.Description property
WindowsAuthOptions.DisplayName property
WindowsAuthOptions.DocumentationId property
WindowsAuthOptions.GlobalScheme property
WindowsAuthOptions.Host property
WindowsAuthOptions.Logger property
WindowsAuthOptions.Protocol property
WindowsAuthProtocol enumeration
Kestrun.Callback
CallbackBodyPlan constructor
CallbackBodyPlan record
CallbackBodyPlan.MediaType property
CallbackDispatchOptions constructor
CallbackDispatchOptions record
CallbackDispatchOptions.BaseDelay property
CallbackDispatchOptions.DefaultTimeout property
CallbackDispatchOptions.MaxAttempts property
CallbackDispatchOptions.MaxDelay property
CallBackExecutionPlan constructor
CallBackExecutionPlan record
CallBackExecutionPlan.BodyParameterName property
CallBackExecutionPlan.CallbackId property
CallBackExecutionPlan.Parameters property
CallBackExecutionPlan.Plan property
CallbackParamPlan constructor
CallbackParamPlan record
CallbackParamPlan.Location property
CallbackParamPlan.Name property
CallbackPlan constructor
CallbackPlan record
CallbackPlan.Body property
CallbackPlan.CallbackId property
CallbackPlan.Method property
CallbackPlan.OperationId property
CallbackPlan.PathParams property
CallbackPlan.UrlTemplate property
CallbackRequest class
CallbackRequest constructor
CallbackRequest.Attempt property
CallbackRequest.Body property
CallbackRequest.CallbackId property
CallbackRequest.ContentType property
CallbackRequest.CorrelationId property
CallbackRequest.CreatedAt property
CallbackRequest.Headers property
CallbackRequest.HttpMethod property
CallbackRequest.IdempotencyKey property
CallbackRequest.NextAttemptAt property
CallbackRequest.OperationId property
CallbackRequest.TargetUrl property
CallbackRequest.Timeout property
CallbackRequestFactory class
CallbackRequestFactory.FromPlan method
CallbackResult constructor
CallbackResult record
CallbackResult.CompletedAt property
CallbackResult.ErrorMessage property
CallbackResult.ErrorType property
CallbackResult.StatusCode property
CallbackResult.Success property
CallbackRuntimeContext constructor
CallbackRuntimeContext record
CallbackRuntimeContext.CallbackPayload property
CallbackRuntimeContext.CorrelationId property
CallbackRuntimeContext.DefaultBaseUri property
CallbackRuntimeContext.IdempotencyKeySeed property
CallbackRuntimeContext.Vars property
ICallbackBodySerializer interface
ICallbackBodySerializer.Serialize method
ICallbackDispatcher interface
ICallbackDispatcher.EnqueueAsync method
ICallbackRetryPolicy interface
ICallbackRetryPolicy.Evaluate method
ICallbackSender interface
ICallbackSender.SendAsync method
ICallbackSigner interface
ICallbackSigner.Sign method
ICallbackStore interface
ICallbackStore.DequeueDueAsync method
ICallbackStore.MarkFailedPermanentAsync method
ICallbackStore.MarkInFlightAsync method
ICallbackStore.MarkRetryScheduledAsync method
ICallbackStore.MarkSucceededAsync method
ICallbackStore.SaveNewAsync method
ICallbackUrlResolver interface
ICallbackUrlResolver.Resolve method
RetryDecision constructor
RetryDecision record
RetryDecision.Delay property
RetryDecision.Kind property
RetryDecision.NextAttemptAt property
RetryDecision.Reason property
RetryDecisionKind enumeration
Kestrun.Certificates
CertificateManager class
CertificateManager.BuildPrivateKeyJwt method (1 of 2)
CertificateManager.BuildPrivateKeyJwtFromJwkJson method
CertificateManager.CreateJwkJsonFromCertificate method
CertificateManager.CreateJwkJsonFromRsa method
CertificateManager.CreateJwkJsonFromRsaPrivateKeyPem method
CertificateManager.CreateSelfSignedCertificateFromJwk method
CertificateManager.Export method (1 of 2)
CertificateManager.ExportPemFromJwkJson method (1 of 2)
CertificateManager.GetPurposes method
CertificateManager.Import method (1 of 4)
CertificateManager.NewCertificateRequest method
CertificateManager.NewSelfSigned method
CertificateManager.Validate method (1 of 4)
ClientCertificateValidationCallbacks class
ClientCertificateValidationCallbacks.AllowAny method
ClientCertificateValidationCallbacks.AllowMissingOrSelfSignedForDevelopment method
ClientCertificateValidationCallbacks.AllowSelfSignedForDevelopment method
ClientCertificateValidationCompiler class
ClientCertificateValidationCompiler.Compile method
CsrOptions constructor
CsrOptions record
CsrOptions.CommonName property
CsrOptions.Country property
CsrOptions.DnsNames property
CsrOptions.KeyLength property
CsrOptions.KeyType property
CsrOptions.KeyUsageFlags property
CsrOptions.Org property
CsrOptions.OrgUnit property
CsrResult constructor
CsrResult record
CsrResult.CsrDer property
CsrResult.CsrPem property
CsrResult.PrivateKey property
CsrResult.PrivateKeyDer property
CsrResult.PrivateKeyPem property
CsrResult.PrivateKeyPemEncrypted property
CsrResult.PublicKeyDer property
CsrResult.PublicKeyPem property
ExportFormat enumeration
JwkJson class
JwkJson.Options field
KeyType enumeration
RsaJwk class
RsaJwk constructor
RsaJwk.D property
RsaJwk.DP property
RsaJwk.DQ property
RsaJwk.E property
RsaJwk.Kid property
RsaJwk.Kty property
RsaJwk.N property
RsaJwk.P property
RsaJwk.Q property
RsaJwk.QI property
SelfSignedCertificateResult constructor
SelfSignedCertificateResult record
SelfSignedCertificateResult.Certificate property
SelfSignedCertificateResult.IsDevelopmentCertificate property
SelfSignedCertificateResult.LeafCertificate property
SelfSignedCertificateResult.PublicRootCertificate property
SelfSignedCertificateResult.RootCertificate property
SelfSignedCertificateResult.RootTrusted property
SelfSignedOptions constructor
SelfSignedOptions record
SelfSignedOptions.Development property
SelfSignedOptions.DnsNames property
SelfSignedOptions.Ephemeral property
SelfSignedOptions.Exportable property
SelfSignedOptions.IsCertificateAuthority property
SelfSignedOptions.IssuerCertificate property
SelfSignedOptions.KeyLength property
SelfSignedOptions.KeyType property
SelfSignedOptions.KeyUsageFlags property
SelfSignedOptions.LeafValidDays property
SelfSignedOptions.Purposes property
SelfSignedOptions.RootCertificate property
SelfSignedOptions.RootName property
SelfSignedOptions.RootValidDays property
SelfSignedOptions.TrustRoot property
SelfSignedOptions.ValidDays property
Kestrun.Claims
ClaimPolicyBuilder class
ClaimPolicyBuilder constructor
ClaimPolicyBuilder.AddPolicy method (1 of 3)
ClaimPolicyBuilder.Build method
ClaimPolicyBuilder.Clear method
ClaimPolicyBuilder.Create method
ClaimPolicyBuilder.Policies property
ClaimPolicyBuilder.ToString method
ClaimPolicyConfig class
ClaimPolicyConfig constructor
ClaimPolicyConfig.AddPolicies method
ClaimPolicyConfig.AddPolicy method
ClaimPolicyConfig.Count property
ClaimPolicyConfig.GetPolicy method
ClaimPolicyConfig.Policies property
ClaimPolicyConfig.PolicyNames property
ClaimPolicyExtensions class
ClaimPolicyExtensions.ToAuthzDelegate method
ClaimPolicyPostConfigurer class
ClaimPolicyPostConfigurer constructor
ClaimPolicyPostConfigurer.PostConfigure method
ClaimRule constructor (1 of 3)
ClaimRule record
ClaimRule.AllowedValues property
ClaimRule.ClaimType property
ClaimRule.Description property
KestrunClaimExtensions class
KestrunClaimExtensions.ToClaimUri method
UserIdentityClaim enumeration
Kestrun.Client
KrHttpClientFactory class
KrHttpClientFactory.CreateNamedPipeClient method (1 of 3)
KrHttpClientFactory.CreateTcpClient method (1 of 3)
KrHttpClientFactory.CreateUnixSocketClient method (1 of 3)
KrHttpClientOptions class
KrHttpClientOptions constructor
KrHttpClientOptions.AllowAutoRedirect property
KrHttpClientOptions.Cookies property
KrHttpClientOptions.Credentials property
KrHttpClientOptions.Decompression property
KrHttpClientOptions.IgnoreCertErrors property
KrHttpClientOptions.MaxAutomaticRedirections property
KrHttpClientOptions.Proxy property
KrHttpClientOptions.ProxyUseDefaultCredentials property
KrHttpClientOptions.Timeout property
KrHttpClientOptions.UseDefaultCredentials property
KrHttpClientOptions.UseProxy property
KrHttpDownloads class
KrHttpDownloads.DownloadToFileAsync method
Kestrun.Forms
IKrFormPayload interface
IKrPartSink interface
IKrPartSink.WriteAsync method
KrDiskPartSink class
KrDiskPartSink constructor
KrDiskPartSink.WriteAsync method
KrFilePart record
KrFilePart.ContentType property
KrFilePart.Headers property
KrFilePart.Length property
KrFilePart.Name property
KrFilePart.OriginalFileName property
KrFilePart.Sha256 property
KrFilePart.TempPath property
KrFormContext constructor
KrFormContext record
KrFormContext.Host property
KrFormContext.HttpContext property
KrFormContext.KestrunContext property
KrFormContext.Logger property
KrFormContext.Options property
KrFormContext.Payload property
KrFormData class
KrFormData constructor
KrFormData.Fields property
KrFormData.Files property
KrFormEndpoints class
KrFormEndpoints.KrFormHandler delegate
KrFormEndpoints.MapKestrunFormRoute method
KrFormException class
KrFormException constructor
KrFormException.StatusCode property
KrFormLimitExceededException class
KrFormLimitExceededException constructor
KrFormLimits class
KrFormLimits constructor (1 of 2)
KrFormLimits.MaxFieldValueBytes property
KrFormLimits.MaxHeaderBytesPerPart property
KrFormLimits.MaxNestingDepth property
KrFormLimits.MaxPartBodyBytes property
KrFormLimits.MaxParts property
KrFormLimits.MaxRequestBodyBytes property
KrFormLimits.ToString method
KrFormOptions class
KrFormOptions constructor (1 of 2)
KrFormOptions.AllowedContentTypes property
KrFormOptions.AllowedPartContentEncodings property
KrFormOptions.ComputeSha256 property
KrFormOptions.DefaultUploadPath property
KrFormOptions.Description property
KrFormOptions.EnablePartDecompression property
KrFormOptions.Limits property
KrFormOptions.Logger property
KrFormOptions.MaxDecompressedBytesPerPart property
KrFormOptions.Name property
KrFormOptions.OnCompleted property
KrFormOptions.OnPart property
KrFormOptions.RejectUnknownContentEncoding property
KrFormOptions.RejectUnknownRequestContentType property
KrFormOptions.Rules property
KrFormOptions.SanitizeFileName property
KrFormParser class
KrFormParser.Parse method
KrFormParser.ParseAsync method
KrFormPartRule class
KrFormPartRule.AllowedContentTypes property
KrFormPartRule.AllowedExtensions property
KrFormPartRule.AllowMultiple property
KrFormPartRule.DecodeMode property
KrFormPartRule.Description property
KrFormPartRule.DestinationPath property
KrFormPartRule.MaxBytes property
KrFormPartRule.Name property
KrFormPartRule.NestedRules property
KrFormPartRule.Required property
KrFormPartRule.Scope property
KrFormPartRule.StoreToDisk property
KrMultipart class
KrMultipart constructor
KrMultipart.Parts property
KrPartAction enumeration
KrPartContext constructor
KrPartContext record
KrPartContext.ContentEncoding property
KrPartContext.ContentType property
KrPartContext.DeclaredLength property
KrPartContext.FileName property
KrPartContext.Headers property
KrPartContext.Index property
KrPartContext.Name property
KrPartContext.Rule property
KrPartWriteResult record
KrPartWriteResult.Length property
KrPartWriteResult.Sha256 property
KrPartWriteResult.TempPath property
KrRawPart record
KrRawPart.ContentType property
KrRawPart.Headers property
KrRawPart.Length property
KrRawPart.Name property
KrRawPart.NestedPayload property
KrRawPart.TempPath property
Kestrun.Health
DiskSpaceProbe class
DiskSpaceProbe constructor
DiskSpaceProbe.CheckAsync method
DiskSpaceProbe.Logger property
DiskSpaceProbe.Name property
DiskSpaceProbe.Tags property
HealthEndpointContentType enumeration
HealthEndpointOptions class
HealthEndpointOptions constructor
HealthEndpointOptions.AllowAnonymous property
HealthEndpointOptions.AutoRegisterEndpoint property
HealthEndpointOptions.Clone method
HealthEndpointOptions.Compress property
HealthEndpointOptions.CorsPolicy property
HealthEndpointOptions.DefaultScriptLanguage property
HealthEndpointOptions.DefaultTags property
HealthEndpointOptions.MaxDegreeOfParallelism property
HealthEndpointOptions.OpenApiDescription property
HealthEndpointOptions.OpenApiGroupName property
HealthEndpointOptions.OpenApiOperationId property
HealthEndpointOptions.OpenApiSummary property
HealthEndpointOptions.OpenApiTags property
HealthEndpointOptions.Pattern property
HealthEndpointOptions.ProbeTimeout property
HealthEndpointOptions.RateLimitPolicyName property
HealthEndpointOptions.RequirePolicies property
HealthEndpointOptions.RequireSchemes property
HealthEndpointOptions.ResponseContentType property
HealthEndpointOptions.ShortCircuit property
HealthEndpointOptions.ShortCircuitStatusCode property
HealthEndpointOptions.ThrowOnDuplicate property
HealthEndpointOptions.TreatDegradedAsUnhealthy property
HealthEndpointOptions.XmlRootElementName property
HealthProbeEntry constructor
HealthProbeEntry record
HealthProbeEntry.Data property
HealthProbeEntry.Description property
HealthProbeEntry.Duration property
HealthProbeEntry.Error property
HealthProbeEntry.Name property
HealthProbeEntry.Status property
HealthProbeEntry.StatusText property
HealthProbeEntry.Tags property
HealthReport constructor
HealthReport record
HealthReport.AppliedTags property
HealthReport.GeneratedAt property
HealthReport.Probes property
HealthReport.Status property
HealthReport.StatusText property
HealthReport.Summary property
HealthReportTextFormatter class
HealthReportTextFormatter.Format method
HealthSummary constructor
HealthSummary record
HealthSummary.Degraded property
HealthSummary.Healthy property
HealthSummary.Total property
HealthSummary.Unhealthy property
HttpProbe class
HttpProbe constructor
HttpProbe.CheckAsync method
HttpProbe.Logger property
HttpProbe.Name property
HttpProbe.Tags property
IProbe interface
IProbe.CheckAsync method
IProbe.Name property
IProbe.TAG_SELF field
IProbe.Tags property
Probe class
Probe.CheckAsync method
Probe.Name property
Probe.Tags property
ProbeResult constructor
ProbeResult record
ProbeResult.Data property
ProbeResult.Description property
ProbeResult.Status property
ProbeStatus enumeration
ProbeStatusLabels class
ProbeStatusLabels.STATUS_DEGRADED field
ProbeStatusLabels.STATUS_FAIL field
ProbeStatusLabels.STATUS_FAILED field
ProbeStatusLabels.STATUS_HEALTHY field
ProbeStatusLabels.STATUS_OK field
ProbeStatusLabels.STATUS_UNHEALTHY field
ProbeStatusLabels.STATUS_WARN field
ProbeStatusLabels.STATUS_WARNING field
ProcessProbe class
ProcessProbe constructor
ProcessProbe.CheckAsync method
ProcessProbe.Logger property
ProcessProbe.Name property
ProcessProbe.Tags property
Kestrun.Hosting
KestrunHost class
KestrunHost constructor (1 of 3)
KestrunHost.AddCallbacksAutomation method
KestrunHost.AddControllers method
KestrunHost.AddDefaultFiles method (1 of 2)
KestrunHost.AddDirectoryBrowser method
KestrunHost.AddFavicon method
KestrunHost.AddFeature method
KestrunHost.AddFileServer method (1 of 2)
KestrunHost.AddFormOption method
KestrunHost.AddFormPartRule method
KestrunHost.AddHealthEndpoint method (1 of 2)
KestrunHost.AddLocalization method (1 of 2)
KestrunHost.AddPowerShellRazorPages method (1 of 6)
KestrunHost.AddPowerShellRuntime method
KestrunHost.AddProbe method (1 of 3)
KestrunHost.AddRazorPages method (1 of 2)
KestrunHost.AddScheduling method
KestrunHost.AddService method
KestrunHost.AddSignalR method (1 of 2)
KestrunHost.AddSseBroadcast method
KestrunHost.AddStaticFiles method (1 of 2)
KestrunHost.AddTasks method
KestrunHost.AntiforgeryOptions property
KestrunHost.ApplicationName property
KestrunHost.BroadcastSseEventAsync method
KestrunHost.Build method
KestrunHost.ComponentAnnotations property
KestrunHost.ConfigureListener method (1 of 5)
KestrunHost.CorsPolicyDefined property
KestrunHost.CreateRunspacePool method
KestrunHost.CurrentUrls property
KestrunHost.DefaultCacheControl property
KestrunHost.DefaultHost property
KestrunHost.DefaultOpenApiDocumentDescriptor property
KestrunHost.DefinedCorsPolicyNames property
KestrunHost.Dispose method
KestrunHost.EnableConfiguration method
KestrunHost.ExceptionOptions property
KestrunHost.ForwardedHeaderOptions property
KestrunHost.GetFormOption method
KestrunHost.GetFormPartRule method
KestrunHost.GetOrCreateOpenApiDocument method (1 of 2)
KestrunHost.GetSseConnectedClientCount method
KestrunHost.IsConfigured property
KestrunHost.IsQuicSupported method
KestrunHost.IsRunning property
KestrunHost.IsServiceRegistered method (1 of 2)
KestrunHost.KestrunRoot property
KestrunHost.LocalizationStore property
KestrunHost.Logger property
KestrunHost.ModulePaths property
KestrunHost.OpenApiDocumentDescriptor property
KestrunHost.OpenApiDocumentIds property
KestrunHost.Options property
KestrunHost.PowerShellErrorResponseScript property
KestrunHost.PowershellMiddlewareEnabled property
KestrunHost.RegisteredAuthentications property
KestrunHost.RegisteredRoutes property
KestrunHost.RouteGroupStack property
KestrunHost.Run method
KestrunHost.Runtime property
KestrunHost.Scheduler property
KestrunHost.SharedState property
KestrunHost.StartAsync method
KestrunHost.StatusCodeOptions property
KestrunHost.Stop method
KestrunHost.StopAsync method
KestrunHost.Tasks property
KestrunHost.Use method
KestrunHostAuthnExtensions class
KestrunHostAuthnExtensions.AddApiKeyAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddAuthorization method
KestrunHostAuthnExtensions.AddBasicAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddClientCertificateAuthentication method (1 of 3)
KestrunHostAuthnExtensions.AddCookieAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddGitHubOAuthAuthentication method
KestrunHostAuthnExtensions.AddJwtBearerAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddOAuth2Authentication method
KestrunHostAuthnExtensions.AddOpenIdConnectAuthentication method
KestrunHostAuthnExtensions.AddWindowsAuthentication method (1 of 3)
KestrunHostAuthnExtensions.HasAuthPolicy method
KestrunHostAuthnExtensions.HasAuthScheme method
KestrunHostMapExtensions class
KestrunHostMapExtensions.AddAntiforgeryTokenRoute method
KestrunHostMapExtensions.AddElementsUiRoute method
KestrunHostMapExtensions.AddFormRoute method
KestrunHostMapExtensions.AddHtmlTemplateRoute method (1 of 2)
KestrunHostMapExtensions.AddMapRoute method (1 of 6)
KestrunHostMapExtensions.AddOpenApiMapRoute method
KestrunHostMapExtensions.AddRapiDocUiRoute method
KestrunHostMapExtensions.AddRedocUiRoute method
KestrunHostMapExtensions.AddScalarUiRoute method
KestrunHostMapExtensions.AddSwaggerUiRoute method
KestrunHostMapExtensions.ApplyKestrunConventions method
KestrunHostMapExtensions.EndpointSpecParser class
KestrunHostMapExtensions.EndpointSpecParser.TryParse method
KestrunHostMapExtensions.GetMapRouteOptions method
KestrunHostMapExtensions.KestrunHandler delegate
KestrunHostMapExtensions.MapExists method (1 of 2)
KestrunHostMapExtensions.TryParseEndpointSpec method
KestrunHostRuntime constructor
KestrunHostRuntime record
KestrunHostRuntime.FormOptions property
KestrunHostRuntime.FormPartRules property
KestrunHostRuntime.StartTime property
KestrunHostRuntime.StopTime property
KestrunHostRuntime.Uptime property
KestrunHostScriptValidationExtensions class
KestrunHostScriptValidationExtensions.GetCSharpScriptErrors method
KestrunHostScriptValidationExtensions.IsCSharpScriptValid method
KestrunHostScriptValidationExtensions.ValidateCSharpScript method
KestrunHostSessionExtensions class
KestrunHostSessionExtensions.AddDistributedMemoryCache method
KestrunHostSessionExtensions.AddDistributedSqlServerCache method
KestrunHostSessionExtensions.AddSession method
KestrunHostSessionExtensions.AddStackExchangeRedisCache method
KestrunHostSessionExtensions.IsDistributedCacheRegistered method
KestrunHostSignalRExtensions class
KestrunHostSignalRExtensions.BroadcastEventAsync method
KestrunHostSignalRExtensions.BroadcastLogAsync method
KestrunHostSignalRExtensions.BroadcastToGroupAsync method
KestrunHostSignalRExtensions.GetConnectedClientCount method
KestrunHttpMiddlewareExtensions class
KestrunHttpMiddlewareExtensions.AddCommonAccessLog method (1 of 2)
KestrunHttpMiddlewareExtensions.AddHsts method (1 of 2)
KestrunHttpMiddlewareExtensions.AddHttpsRedirection method (1 of 2)
KestrunHttpMiddlewareExtensions.AddResponseCaching method (1 of 2)
KestrunHttpMiddlewareExtensions.AddResponseCompression method (1 of 2)
KestrunSecurityMiddlewareExtensions class
KestrunSecurityMiddlewareExtensions.AddAntiforgery method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsDefaultPolicy method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsDefaultPolicyAllowAll method
KestrunSecurityMiddlewareExtensions.AddCorsPolicy method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsPolicyAllowAll method
KestrunSecurityMiddlewareExtensions.AddHostFiltering method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddRateLimiter method (1 of 2)
NoopHostLifetime class
NoopHostLifetime constructor
NoopHostLifetime.StopAsync method
NoopHostLifetime.WaitForStartAsync method
Kestrun.Hosting.Compression
KestrunCompressionServiceCollectionExtensions class
KestrunCompressionServiceCollectionExtensions.AddKestrunCompressionOptOut method
KestrunResponseCompressionProvider class
KestrunResponseCompressionProvider constructor
KestrunResponseCompressionProvider.CheckRequestAcceptsCompression method
KestrunResponseCompressionProvider.GetCompressionProvider method
KestrunResponseCompressionProvider.ShouldCompressResponse method
KrRequestDecompressionExtensions class
KrRequestDecompressionExtensions.AddRequestDecompression method (1 of 2)
Kestrun.Hosting.Options
ContentTypeWithSchema constructor
ContentTypeWithSchema record
ContentTypeWithSchema.ContentType property
ContentTypeWithSchema.Schema property
DefaultResponseContentType constructor
DefaultResponseContentType record
DefaultResponseContentType.ContentType property
ExceptionOptions class
ExceptionOptions constructor
ExceptionOptions.DeveloperExceptionPageOptions property
ExceptionOptions.Host property
ExceptionOptions.LanguageOptions property
ExceptionOptions.LegacyStatusCodeSelector property
ExceptionOptions.UseJsonExceptionHandler method
KestrelOptionsExtensions class
KestrelOptionsExtensions.CopyFromTemplate method
KestrunOptions class
KestrunOptions constructor
KestrunOptions.ApplicationName property
KestrunOptions.DefaultApiResponseMediaType property
KestrunOptions.DefaultResponseMediaType property
KestrunOptions.DefaultUploadPath property
KestrunOptions.Health property
KestrunOptions.HttpsConnectionAdapter property
KestrunOptions.Listeners property
KestrunOptions.ListenUnixSockets property
KestrunOptions.MaxRunspaces property
KestrunOptions.MaxSchedulerRunspaces property
KestrunOptions.MinRunspaces property
KestrunOptions.NamedPipeNames property
KestrunOptions.NamedPipeOptions property
KestrunOptions.ServerLimits property
KestrunOptions.ServerOptions property
LanguageOptions constructor
LanguageOptions record
LanguageOptions.Arguments property
LanguageOptions.Code property
LanguageOptions.ExtraImports property
LanguageOptions.ExtraRefs property
LanguageOptions.Language property
LanguageOptions.LanguageVersion property
LanguageOptions.Parameters property
LanguageOptions.ScriptBlock property
ListenerOptions class
ListenerOptions constructor
ListenerOptions.DisableAltSvcHeader property
ListenerOptions.IPAddress property
ListenerOptions.Port property
ListenerOptions.Protocols property
ListenerOptions.ToString method
ListenerOptions.UseConnectionLogging property
ListenerOptions.UseHttps property
ListenerOptions.X509Certificate property
MapRouteOptions class
MapRouteOptions constructor
MapRouteOptions.AddSecurityRequirementObject method
MapRouteOptions.AllowAnonymous property
MapRouteOptions.AllowedRequestContentTypes property
MapRouteOptions.CallbackPlan property
MapRouteOptions.CorsPolicy property
MapRouteOptions.DefaultResponseContentType property
MapRouteOptions.DisableAntiforgery property
MapRouteOptions.DisableResponseCompression property
MapRouteOptions.Endpoints property
MapRouteOptions.FormOptions property
MapRouteOptions.HandlerName property
MapRouteOptions.HttpVerbs property
MapRouteOptions.IsOpenApiAnnotatedFunctionRoute property
MapRouteOptions.OpenAPI property
MapRouteOptions.PathLevelOpenAPIMetadata property
MapRouteOptions.Pattern property
MapRouteOptions.RateLimitPolicyName property
MapRouteOptions.RequirePolicies property
MapRouteOptions.RequireSchemes property
MapRouteOptions.ScriptCode property
MapRouteOptions.ShortCircuit property
MapRouteOptions.ShortCircuitStatusCode property
MapRouteOptions.ThrowOnDuplicate property
MapRouteOptions.ToString method
OpenAPICommonMetadata constructor (1 of 2)
OpenAPICommonMetadata record
OpenAPICommonMetadata.CorsPolicy property
OpenAPICommonMetadata.Description property
OpenAPICommonMetadata.Enabled property
OpenAPICommonMetadata.MapOptions property
OpenAPICommonMetadata.Parameters property
OpenAPICommonMetadata.Pattern property
OpenAPICommonMetadata.Servers property
OpenAPICommonMetadata.Summary property
OpenApiMapRouteOptions constructor
OpenApiMapRouteOptions record
OpenApiMapRouteOptions.DefaultFormat property
OpenApiMapRouteOptions.DefaultVersion property
OpenApiMapRouteOptions.DocId property
OpenApiMapRouteOptions.FormatVarName property
OpenApiMapRouteOptions.MapOptions property
OpenApiMapRouteOptions.RefreshVarName property
OpenApiMapRouteOptions.SpecVersions property
OpenApiMapRouteOptions.VersionVarName property
OpenAPIPathMetadata constructor (1 of 2)
OpenAPIPathMetadata record
OpenAPIPathMetadata.Callbacks property
OpenAPIPathMetadata.Deprecated property
OpenAPIPathMetadata.DocumentId property
OpenAPIPathMetadata.DocumentIds property
OpenAPIPathMetadata.Expression property
OpenAPIPathMetadata.Extensions property
OpenAPIPathMetadata.ExternalDocs property
OpenAPIPathMetadata.Inline property
OpenAPIPathMetadata.IsOpenApiCallback property
OpenAPIPathMetadata.IsOpenApiPath property
OpenAPIPathMetadata.IsOpenApiWebhook property
OpenAPIPathMetadata.OperationId property
OpenAPIPathMetadata.PathLikeKind property
OpenAPIPathMetadata.RequestBody property
OpenAPIPathMetadata.Responses property
OpenAPIPathMetadata.SecuritySchemes property
OpenAPIPathMetadata.Tags property
SignalROptions constructor
SignalROptions record
SignalROptions.Default property
SignalROptions.DefaultDescription field
SignalROptions.DefaultHubName field
SignalROptions.DefaultPath field
SignalROptions.DefaultSummary field
SignalROptions.DefaultTag field
SignalROptions.Description property
SignalROptions.DocId property
SignalROptions.HubName property
SignalROptions.IncludeNegotiateEndpoint property
SignalROptions.Path property
SignalROptions.SkipOpenApi property
SignalROptions.Summary property
SignalROptions.Tags property
SseBroadcastOptions constructor
SseBroadcastOptions record
SseBroadcastOptions.ContentType property
SseBroadcastOptions.Default property
SseBroadcastOptions.DefaultDescription field
SseBroadcastOptions.DefaultKeepAliveSeconds field
SseBroadcastOptions.DefaultOperationId field
SseBroadcastOptions.DefaultPath field
SseBroadcastOptions.DefaultResponseDescription field
SseBroadcastOptions.DefaultSummary field
SseBroadcastOptions.DefaultTag field
SseBroadcastOptions.Description property
SseBroadcastOptions.DocId property
SseBroadcastOptions.ItemSchemaFormat property
SseBroadcastOptions.ItemSchemaType property
SseBroadcastOptions.KeepAliveSeconds property
SseBroadcastOptions.OperationId property
SseBroadcastOptions.Path property
SseBroadcastOptions.ResponseDescription property
SseBroadcastOptions.SkipOpenApi property
SseBroadcastOptions.StatusCode property
SseBroadcastOptions.Summary property
SseBroadcastOptions.Tags property
StatusCodeOptions class
StatusCodeOptions constructor
StatusCodeOptions.BodyFormat property
StatusCodeOptions.ContentType property
StatusCodeOptions.Host property
StatusCodeOptions.LanguageOptions property
StatusCodeOptions.LocationFormat property
StatusCodeOptions.Options property
StatusCodeOptions.PathFormat property
StatusCodeOptions.QueryFormat property
Kestrun.Jwt
JwkUtilities class
JwkUtilities.ComputeThumbprintFromCertificate method
JwkUtilities.ComputeThumbprintRsa method
JwtAlgorithm enumeration
JwtAlgorithmExtensions class
JwtAlgorithmExtensions.ToJwtString method
JwtBuilderResult class
JwtBuilderResult constructor
JwtBuilderResult.Expires property
JwtBuilderResult.GetValidationParameters method
JwtBuilderResult.IssuedAt property
JwtBuilderResult.Token method
JwtBuilderResult.Validate method
JwtBuilderResult.ValidateAsync method
JwtInspector class
JwtInspector.ReadAllParameters method
JwtParameters class
JwtParameters constructor
JwtParameters.Algorithm property
JwtParameters.Audiences property
JwtParameters.Claims property
JwtParameters.Expires property
JwtParameters.Header property
JwtParameters.IssuedAt property
JwtParameters.Issuer property
JwtParameters.KeyId property
JwtParameters.NotBefore property
JwtParameters.Subject property
JwtParameters.Type property
JwtTokenBuilder class
JwtTokenBuilder constructor
JwtTokenBuilder.AddClaim method
JwtTokenBuilder.AddHeader method
JwtTokenBuilder.Algorithm property
JwtTokenBuilder.Audience property
JwtTokenBuilder.Build method
JwtTokenBuilder.CloneBuilder method
JwtTokenBuilder.EncryptWithCertificate method
JwtTokenBuilder.EncryptWithJwkJson method
JwtTokenBuilder.EncryptWithJwkPath method
JwtTokenBuilder.EncryptWithPemPublic method
JwtTokenBuilder.EncryptWithSecret method
JwtTokenBuilder.EncryptWithSecretB64 method
JwtTokenBuilder.EncryptWithSecretHex method
JwtTokenBuilder.Issuer property
JwtTokenBuilder.New method
JwtTokenBuilder.NotBefore method
JwtTokenBuilder.RenewJwt method (1 of 2)
JwtTokenBuilder.SignWithCertificate method
JwtTokenBuilder.SignWithJwkJson method
JwtTokenBuilder.SignWithRsaPem method
JwtTokenBuilder.SignWithSecret method
JwtTokenBuilder.SignWithSecretHex method
JwtTokenBuilder.SignWithSecretPassphrase method
JwtTokenBuilder.ValidFor method
JwtTokenBuilder.WithAudience method
JwtTokenBuilder.WithIssuer method
JwtTokenBuilder.WithSubject method
Kestrun.KrException
AcceptHeaderException class
AcceptHeaderException constructor
AcceptHeaderException.StatusCode property
ParameterForInjectionException class
ParameterForInjectionException constructor
ParameterForInjectionException.StatusCode property
Kestrun.Languages
CsGlobals constructor (1 of 4)
CsGlobals record
CsGlobals.Context property
CsGlobals.Globals property
CsGlobals.Locals property
ParameterForInjectionInfo class
ParameterForInjectionInfo constructor (1 of 2)
ParameterForInjectionInfoBase class
ParameterForInjectionInfoBase.ContentTypes property
ParameterForInjectionInfoBase.DefaultValue property
ParameterForInjectionInfoBase.Explode property
ParameterForInjectionInfoBase.FormOptions property
ParameterForInjectionInfoBase.In property
ParameterForInjectionInfoBase.IsRequestBody property
ParameterForInjectionInfoBase.Name property
ParameterForInjectionInfoBase.ParameterType property
ParameterForInjectionInfoBase.Style property
ParameterForInjectionInfoBase.Type property
ParameterForInjectionResolved class
ParameterForInjectionResolved constructor
ParameterForInjectionResolved.Value property
Kestrun.Localization
KestrunLocalizationOptions class
KestrunLocalizationOptions constructor
KestrunLocalizationOptions.CookieName property
KestrunLocalizationOptions.DefaultCulture property
KestrunLocalizationOptions.EnableAcceptLanguage property
KestrunLocalizationOptions.EnableCookie property
KestrunLocalizationOptions.EnableQuery property
KestrunLocalizationOptions.FileName property
KestrunLocalizationOptions.QueryKey property
KestrunLocalizationOptions.ResourcesBasePath property
KestrunLocalizationOptions.SetDefaultThreadCulture property
KestrunLocalizationStore class
KestrunLocalizationStore constructor
KestrunLocalizationStore indexer
KestrunLocalizationStore.AvailableCultures property
KestrunLocalizationStore.GetStringsForCulture method
KestrunLocalizationStore.GetStringsForResolvedCulture method
KestrunLocalizationStore.Logger property
KestrunLocalizationStore.ResolveCulture method
Kestrun.Logging
LoggerConfigurationExtensions class
LoggerConfigurationExtensions.EnsureSwitch method
LoggerConfigurationExtensions.Register method
LoggerExtensions class
LoggerExtensions.DebugSanitized method (1 of 2)
LoggerExtensions.ErrorSanitized method
LoggerExtensions.WarningSanitized method (1 of 2)
LoggerManager class
LoggerManager.Clear method
LoggerManager.CloseAndFlush method (1 of 2)
LoggerManager.Contains method (1 of 3)
LoggerManager.DefaultLogger property
LoggerManager.DefaultLoggerName property
LoggerManager.Get method
LoggerManager.GetDefault method
LoggerManager.GetLevelSwitch method
LoggerManager.GetName method
LoggerManager.List method
LoggerManager.ListLevels method
LoggerManager.ListLoggers method
LoggerManager.New method
LoggerManager.Register method
LoggerManager.SetLevelSwitch method
LoggerManager.TryGetName method
Kestrun.Logging.Data
ErrorRecordWrapper class
ErrorRecordWrapper constructor
ErrorRecordWrapper.CategoryInfo property
ErrorRecordWrapper.ErrorDetails property
ErrorRecordWrapper.ExceptionDetails property
ErrorRecordWrapper.ExceptionMessage property
ErrorRecordWrapper.FullyQualifiedErrorId property
ErrorRecordWrapper.InvocationInfoWrapper property
ErrorRecordWrapper.PipelineIterationInfo property
ErrorRecordWrapper.ScriptStackTrace property
ErrorRecordWrapper.TargetObject property
ErrorRecordWrapper.ToString method
InvocationInfoWrapper class
InvocationInfoWrapper constructor
InvocationInfoWrapper.BoundParameters property
InvocationInfoWrapper.CommandOrigin property
InvocationInfoWrapper.DisplayScriptPosition property
InvocationInfoWrapper.ExpectingInput property
InvocationInfoWrapper.HistoryId property
InvocationInfoWrapper.InvocationName property
InvocationInfoWrapper.Line property
InvocationInfoWrapper.MyCommand property
InvocationInfoWrapper.OffsetInLine property
InvocationInfoWrapper.PipelineLength property
InvocationInfoWrapper.PipelinePosition property
InvocationInfoWrapper.PositionMessage property
InvocationInfoWrapper.PSCommandPath property
InvocationInfoWrapper.PSScriptRoot property
InvocationInfoWrapper.ScriptLineNumber property
InvocationInfoWrapper.ScriptName property
InvocationInfoWrapper.ToString method
InvocationInfoWrapper.UnboundArguments property
Kestrun.Logging.Enrichers.Extensions
ErrorRecordEnricherExtensions class
ErrorRecordEnricherExtensions.WithErrorRecord method
ErrorRecordExtensions class
ErrorRecordExtensions.ToTable method (1 of 2)
Kestrun.Logging.Exceptions
WrapperException class
WrapperException constructor (1 of 4)
WrapperException.ErrorRecordWrapper property
WrapperException.ToString method
Kestrun.Logging.Sinks
PowerShellSink class
PowerShellSink constructor
PowerShellSink.Callback property
PowerShellSink.DEFAULT_OUTPUT_TEMPLATE field
PowerShellSink.Emit method
PowerShellSink.TextFormatter property
Kestrun.Logging.Sinks.Extensions
PowerShellSinkExtensions class
PowerShellSinkExtensions.PowerShell method
Kestrun.Logging.Utils.Console
Padding class
Padding constructor (1 of 2)
Padding.Left property
Padding.LeftString method
Padding.Right property
Padding.RightString method
Table class
Table constructor (1 of 2)
Table.AddRow method
Table.BOTTOM_JOINT field
Table.BOTTOM_LEFT_JOINT field
Table.BOTTOM_RIGHT_JOINT field
Table.HeaderSet property
Table.HORIZONTAL_LINE field
Table.LEFT_JOINT field
Table.MIDDLE_JOINT field
Table.Padding property
Table.Render method
Table.RenderWithoutGrid method
Table.RIGHT_JOINT field
Table.SetHeader method
Table.TOP_JOINT field
Table.TOP_LEFT_JOINT field
Table.TOP_RIGHT_JOINT field
Table.ToString method
Table.VERTICAL_LINE field
Kestrun.Logging.Utils.Console.Extensions
TableExtensions class
TableExtensions.AddPropertyRow method
Kestrun.Mcp
IKestrunOpenApiProvider interface
IKestrunOpenApiProvider.GetOpenApi method
IKestrunRequestInvoker interface
IKestrunRequestInvoker.InvokeAsync method
IKestrunRequestValidator interface
IKestrunRequestValidator.Validate method
IKestrunRouteInspector interface
IKestrunRouteInspector.GetRoute method
IKestrunRouteInspector.ListRoutes method
IKestrunRuntimeInspector interface
IKestrunRuntimeInspector.Inspect method
KestrunMcpError constructor
KestrunMcpError record
KestrunMcpError.Code property
KestrunMcpError.Details property
KestrunMcpError.Message property
KestrunOpenApiDocumentResult record
KestrunOpenApiDocumentResult.Document property
KestrunOpenApiDocumentResult.DocumentId property
KestrunOpenApiDocumentResult.Error property
KestrunOpenApiDocumentResult.Version property
KestrunOpenApiProvider class
KestrunOpenApiProvider constructor
KestrunOpenApiProvider.GetOpenApi method
KestrunRequestInput constructor
KestrunRequestInput record
KestrunRequestInput.Body property
KestrunRequestInput.Headers property
KestrunRequestInput.Method property
KestrunRequestInput.Path property
KestrunRequestInput.Query property
KestrunRequestInvoker class
KestrunRequestInvoker constructor
KestrunRequestInvoker.InvokeAsync method
KestrunRequestInvokerOptions constructor
KestrunRequestInvokerOptions record
KestrunRequestInvokerOptions.AllowedPathPatterns property
KestrunRequestInvokerOptions.EnableInvocation property
KestrunRequestInvokerOptions.RedactedHeaders property
KestrunRequestValidationResult record
KestrunRequestValidationResult.Error property
KestrunRequestValidationResult.IsValid property
KestrunRequestValidationResult.Message property
KestrunRequestValidationResult.Route property
KestrunRequestValidationResult.StatusCode property
KestrunRequestValidator class
KestrunRequestValidator constructor
KestrunRequestValidator.Validate method
KestrunRouteDetail record
KestrunRouteDetail.Error property
KestrunRouteDetail.RequestSchemas property
KestrunRouteDetail.Responses property
KestrunRouteDetail.Route property
KestrunRouteInspector class
KestrunRouteInspector constructor
KestrunRouteInspector.GetRoute method
KestrunRouteInspector.ListRoutes method
KestrunRouteInvokeResult record
KestrunRouteInvokeResult.Body property
KestrunRouteInvokeResult.ContentType property
KestrunRouteInvokeResult.Error property
KestrunRouteInvokeResult.Headers property
KestrunRouteInvokeResult.StatusCode property
KestrunRouteResponseSchema record
KestrunRouteResponseSchema.Content property
KestrunRouteResponseSchema.Description property
KestrunRouteSummary record
KestrunRouteSummary.Description property
KestrunRouteSummary.HandlerLanguage property
KestrunRouteSummary.HandlerName property
KestrunRouteSummary.OperationId property
KestrunRouteSummary.Pattern property
KestrunRouteSummary.RequestContentTypes property
KestrunRouteSummary.ResponseContentTypes property
KestrunRouteSummary.Summary property
KestrunRouteSummary.Tags property
KestrunRouteSummary.Verbs property
KestrunRuntimeInspectionResult record
KestrunRuntimeInspectionResult.ApplicationName property
KestrunRuntimeInspectionResult.Configuration property
KestrunRuntimeInspectionResult.Environment property
KestrunRuntimeInspectionResult.Listeners property
KestrunRuntimeInspectionResult.RouteCount property
KestrunRuntimeInspectionResult.StartTimeUtc property
KestrunRuntimeInspectionResult.Status property
KestrunRuntimeInspectionResult.StopTimeUtc property
KestrunRuntimeInspectionResult.Uptime property
KestrunRuntimeInspector class
KestrunRuntimeInspector constructor
KestrunRuntimeInspector.Inspect method
KestrunRuntimeListener record
KestrunRuntimeListener.Protocols property
KestrunRuntimeListener.Url property
KestrunRuntimeListener.UseHttps property
Kestrun.Middleware
CommonAccessLogMiddleware class
CommonAccessLogMiddleware constructor
CommonAccessLogMiddleware.InvokeAsync method
CommonAccessLogOptions class
CommonAccessLogOptions constructor
CommonAccessLogOptions.ClientAddressHeader property
CommonAccessLogOptions.DefaultTimestampFormat field
CommonAccessLogOptions.IncludeElapsedMilliseconds property
CommonAccessLogOptions.IncludeProtocol property
CommonAccessLogOptions.IncludeQueryString property
CommonAccessLogOptions.Level property
CommonAccessLogOptions.Logger property
CommonAccessLogOptions.TimeProvider property
CommonAccessLogOptions.TimestampFormat property
CommonAccessLogOptions.UseUtcTimestamp property
FaviconMiddlewareExtensions class
FaviconMiddlewareExtensions.UseFavicon method
KestrunLocalizationMiddlewareExtensions class
KestrunLocalizationMiddlewareExtensions.UseKestrunLocalization method
KestrunRequestCultureMiddleware class
KestrunRequestCultureMiddleware constructor
KestrunRequestCultureMiddleware.InvokeAsync method
PowerShellRunspaceMiddleware class
PowerShellRunspaceMiddleware constructor
PowerShellRunspaceMiddleware.InvokeAsync method
PowerShellRunspaceMiddlewareExtensions class
PowerShellRunspaceMiddlewareExtensions.UsePowerShellRunspace method
StatusCodePageExtensions class
StatusCodePageExtensions.UseStatusCodePages method
Kestrun.Models
ContentDispositionOptions class
ContentDispositionOptions constructor
ContentDispositionOptions.FileName property
ContentDispositionOptions.ToString method
ContentDispositionOptions.Type property
ContentDispositionType enumeration
KestrunContext constructor
KestrunContext record
KestrunContext.BroadcastEvent method
KestrunContext.BroadcastEventAsync method
KestrunContext.BroadcastLog method
KestrunContext.BroadcastLogAsync method
KestrunContext.BroadcastToGroup method
KestrunContext.BroadcastToGroupAsync method
KestrunContext.Challenge method (1 of 3)
KestrunContext.ChallengeAsync method
KestrunContext.Connection property
KestrunContext.Ct property
KestrunContext.Culture property
KestrunContext.HasRequestCulture property
KestrunContext.HasSession property
KestrunContext.Host property
KestrunContext.HttpContext property
KestrunContext.Items property
KestrunContext.LocalizedStrings property
KestrunContext.Logger property
KestrunContext.MapRouteOptions property
KestrunContext.Parameters property
KestrunContext.Request property
KestrunContext.Response property
KestrunContext.Session property
KestrunContext.SignOut method (1 of 3)
KestrunContext.StartSse method
KestrunContext.Strings property
KestrunContext.TraceIdentifier property
KestrunContext.TryGetSession method
KestrunContext.User property
KestrunContext.WriteSseEvent method
KestrunContext.WriteSseEventAsync method
KestrunRequest class
KestrunRequest.Authorization property
KestrunRequest.Body property
KestrunRequest.ContentLength property
KestrunRequest.ContentType property
KestrunRequest.Cookies property
KestrunRequest.Form property
KestrunRequest.HasFormContentType property
KestrunRequest.Headers property
KestrunRequest.Host property
KestrunRequest.HttpContext property
KestrunRequest.IsHttps property
KestrunRequest.Method property
KestrunRequest.NewRequest method
KestrunRequest.NewRequestSync method
KestrunRequest.Path property
KestrunRequest.PathBase property
KestrunRequest.Protocol property
KestrunRequest.Query property
KestrunRequest.QueryString property
KestrunRequest.Request property
KestrunRequest.RouteValues property
KestrunRequest.Scheme property
KestrunResponse class
KestrunResponse constructor
KestrunResponse.AcceptCharset property
KestrunResponse.AddCallbackParameters method
KestrunResponse.ApplyCachingHeaders method
KestrunResponse.ApplyTo method
KestrunResponse.Body property
KestrunResponse.BodyAsyncThreshold property
KestrunResponse.CacheControl property
KestrunResponse.CallbackPlan property
KestrunResponse.ContentDisposition property
KestrunResponse.ContentType property
KestrunResponse.Context property
KestrunResponse.Cookies property
KestrunResponse.Encoding property
KestrunResponse.GetHeader method
KestrunResponse.HasPostPonedWriteObject property
KestrunResponse.Headers property
KestrunResponse.Host property
KestrunResponse.IsTextBasedContentType method
KestrunResponse.KrContext property
KestrunResponse.MapRouteOptions property
KestrunResponse.PostPonedWriteObject property
KestrunResponse.QueueResponseForWrite method
KestrunResponse.RedirectUrl property
KestrunResponse.Request property
KestrunResponse.RevalidateCache method
KestrunResponse.StatusCode property
KestrunResponse.TextBasedMimeTypes field
KestrunResponse.WriteBinaryResponse method
KestrunResponse.WriteBsonResponse method
KestrunResponse.WriteBsonResponseAsync method
KestrunResponse.WriteCborResponse method
KestrunResponse.WriteCborResponseAsync method
KestrunResponse.WriteCsvResponse method
KestrunResponse.WriteCsvResponseAsync method
KestrunResponse.WriteErrorResponse method (1 of 2)
KestrunResponse.WriteErrorResponseAsync method (1 of 2)
KestrunResponse.WriteFileResponse method
KestrunResponse.WriteFormUrlEncodedResponse method
KestrunResponse.WriteFormUrlEncodedResponseAsync method
KestrunResponse.WriteHtmlResponse method (1 of 2)
KestrunResponse.WriteHtmlResponseAsync method (1 of 2)
KestrunResponse.WriteHtmlResponseFromFile method
KestrunResponse.WriteHtmlResponseFromFileAsync method
KestrunResponse.WriteJsonResponse method (1 of 3)
KestrunResponse.WriteJsonResponseAsync method (1 of 3)
KestrunResponse.WriteObject constructor
KestrunResponse.WriteObject record
KestrunResponse.WriteObject.Error property
KestrunResponse.WriteObject.Status property
KestrunResponse.WriteObject.Value property
KestrunResponse.WriteRedirectResponse method
KestrunResponse.WriteResponse method
KestrunResponse.WriteResponseAsync method (1 of 2)
KestrunResponse.WriteStatusOnly method
KestrunResponse.WriteStreamResponse method
KestrunResponse.WriteTextResponse method
KestrunResponse.WriteTextResponseAsync method
KestrunResponse.WriteXmlResponse method
KestrunResponse.WriteXmlResponseAsync method
KestrunResponse.WriteYamlResponse method
KestrunResponse.WriteYamlResponseAsync method
ResolvedRequestParameters constructor
ResolvedRequestParameters record
ResolvedRequestParameters.Body property
ResolvedRequestParameters.Parameters property
Kestrun.OpenApi
FunctionInfoExtensions class
FunctionInfoExtensions.GetDefaultParameterValue method
HelpExtractor class
HelpExtractor.GetDescription method
HelpExtractor.GetHelp method
HelpExtractor.GetParameterDescription method
HelpExtractor.GetSynopsis method
OaParameterExtensions class
OaParameterExtensions.ToOpenApi method (1 of 2)
OaParameterExtensions.ToOpenApiParameterLocation method
OaParameterExtensions.ToParameterLocation method
OaParameterExtensions.ToParameterStyle method
OaSchemaTypeExtensions class
OaSchemaTypeExtensions.ToJsonSchemaType method
OpenApiComponentAnnotationScanner class
OpenApiComponentAnnotationScanner.AnnotatedVariable class
OpenApiComponentAnnotationScanner.AnnotatedVariable constructor
OpenApiComponentAnnotationScanner.AnnotatedVariable.Annotations property
OpenApiComponentAnnotationScanner.AnnotatedVariable.InitialValue property
OpenApiComponentAnnotationScanner.AnnotatedVariable.InitialValueExpression property
OpenApiComponentAnnotationScanner.AnnotatedVariable.Name property
OpenApiComponentAnnotationScanner.AnnotatedVariable.NoDefault property
OpenApiComponentAnnotationScanner.AnnotatedVariable.VariableType property
OpenApiComponentAnnotationScanner.AnnotatedVariable.VariableTypeName property
OpenApiComponentAnnotationScanner.ScanFromPath method
OpenApiComponentAnnotationScanner.ScanFromRunningScriptOrPath method
OpenApiComponentConflictResolution enumeration
OpenApiComponentKind enumeration
OpenApiComponentKindExtensions class
OpenApiComponentKindExtensions.SupportsInline method
OpenApiComponentKindExtensions.ToInlineLabel method
OpenApiComponentSet class
OpenApiComponentSet constructor
OpenApiComponentSet.CallbackTypes property
OpenApiComponentSet.ExampleTypes property
OpenApiComponentSet.HeaderTypes property
OpenApiComponentSet.LinkTypes property
OpenApiComponentSet.MediaType property
OpenApiComponentSet.ParameterTypes property
OpenApiComponentSet.PathItemTypes property
OpenApiComponentSet.RequestBodyTypes property
OpenApiComponentSet.ResponseTypes property
OpenApiComponentSet.SchemaTypes property
OpenApiComponentSet.SecuritySchemeTypes property
OpenApiDocDescriptor class
OpenApiDocDescriptor constructor
OpenApiDocDescriptor.AddComponentExample method
OpenApiDocDescriptor.AddComponentHeader method
OpenApiDocDescriptor.AddComponentLink method
OpenApiDocDescriptor.AddInlineExample method
OpenApiDocDescriptor.AddInlineLink method
OpenApiDocDescriptor.AddOpenApiExtension method
OpenApiDocDescriptor.AddTag method
OpenApiDocDescriptor.ApplySecurityScheme method
OpenApiDocDescriptor.AutoErrorResponseContentTypes property
OpenApiDocDescriptor.AutoErrorResponseSchemaId property
OpenApiDocDescriptor.Callbacks property
OpenApiDocDescriptor.ContainsTag method
OpenApiDocDescriptor.CreateExternalDocs method (1 of 2)
OpenApiDocDescriptor.CreateInfoContact method
OpenApiDocDescriptor.DefaultAutoErrorResponseContentType field
OpenApiDocDescriptor.DefaultAutoErrorResponseSchemaId field
OpenApiDocDescriptor.DefaultDocumentationId field
OpenApiDocDescriptor.DefaultDocumentationIds field
OpenApiDocDescriptor.Document property
OpenApiDocDescriptor.DocumentId property
OpenApiDocDescriptor.GenerateComponents method
OpenApiDocDescriptor.GenerateDoc method
OpenApiDocDescriptor.HasBeenGenerated property
OpenApiDocDescriptor.Host property
OpenApiDocDescriptor.InferPrimitiveSchema method
OpenApiDocDescriptor.InlineComponents property
OpenApiDocDescriptor.LoadAnnotatedFunctions method
OpenApiDocDescriptor.NewOpenApiExample method (1 of 2)
OpenApiDocDescriptor.NewOpenApiExternalExample method
OpenApiDocDescriptor.NewOpenApiHeader method
OpenApiDocDescriptor.NewOpenApiLink method
OpenApiDocDescriptor.ReadAndDiagnose method
OpenApiDocDescriptor.RemoveTag method
OpenApiDocDescriptor.SecurityRequirement property
OpenApiDocDescriptor.ToJson method
OpenApiDocDescriptor.ToYaml method
OpenApiDocDescriptor.TryGetComponent<T> method
OpenApiDocDescriptor.TryGetInline<T> method
OpenApiDocDescriptor.TryGetTag method
OpenApiDocDescriptor.WebHook property
OpenApiHelper class
OpenApiJsonNodeFactory class
OpenApiJsonNodeFactory.ToNode method
OpenApiPathLikeKind enumeration
OpenApiSchemaDiscovery class
OpenApiSchemaDiscovery.GetOpenApiTypesAuto method
OpenApiSpecVersionExtensions class
OpenApiSpecVersionExtensions.ParseOpenApiSpecVersion method
OpenApiSpecVersionExtensions.ToVersionString method
Rfc6570PathMapping constructor
Rfc6570PathMapping record
Rfc6570PathMapping.KestrelPattern property
Rfc6570PathMapping.OpenApiPattern property
Rfc6570PathMapping.QueryParameters property
Rfc6570PathTemplateMapper class
Rfc6570PathTemplateMapper.TryMapToKestrelRoute method
Rfc6570VariableMapper class
Rfc6570VariableMapper.TryBuildRfc6570Variables method (1 of 2)
Kestrun.Razor
PowerShellRazorPage class
PowerShellRazorPage.UsePowerShellRazorPages method
PwshKestrunModel class
PwshKestrunModel constructor
PwshKestrunModel.Config property
PwshKestrunModel.Data property
PwshKestrunModel.Query method
Kestrun.Runtime
EnvironmentHelper class
EnvironmentHelper.ClearOverride method
EnvironmentHelper.IsDevelopment method
EnvironmentHelper.IsProduction method
EnvironmentHelper.IsStaging method
EnvironmentHelper.Name property
EnvironmentHelper.SetHostEnvironment method
EnvironmentHelper.SetOverride method
EnvironmentHelper.SetOverrideName method
PowerShellOpenApiClassExporter class
PowerShellOpenApiClassExporter.ExportOpenApiClasses method (1 of 2)
PowerShellOpenApiClassExporter.ValidClassNames property
PowerShellOpenApiClassExporter.WriteOpenApiTempScript method
VariablesMap class
VariablesMap.GetCommonProperties method
VariablesMap.GetVariablesMap method
Kestrun.Scheduling
JobInfo constructor
JobInfo record
JobInfo.IsCompleted property
JobInfo.IsSuspended property
JobInfo.LastRunAt property
JobInfo.Name property
JobInfo.NextRunAt property
ScheduleReport constructor
ScheduleReport record
ScheduleReport.GeneratedAt property
ScheduleReport.Jobs property
SchedulerService class
SchedulerService constructor
SchedulerService.Cancel method
SchedulerService.CancelAll method
SchedulerService.CancelAsync method
SchedulerService.Dispose method
SchedulerService.GetReport method
SchedulerService.GetReportHashtable method
SchedulerService.GetSnapshot method (1 of 2)
SchedulerService.Host property
SchedulerService.Pause method
SchedulerService.Resume method
SchedulerService.Schedule method (1 of 8)
SchedulerService.ScheduleAsync method (1 of 2)
Kestrun.Scripting
CompilationErrorException class
CompilationErrorException constructor (1 of 2)
CompilationErrorException.Diagnostics property
CompilationErrorException.GetDetailedErrorMessage method
CompilationErrorException.GetErrors method
CompilationErrorException.GetWarnings method
KestrunRunspacePoolManager class
KestrunRunspacePoolManager constructor
KestrunRunspacePoolManager.Acquire method
KestrunRunspacePoolManager.AcquireAsync method
KestrunRunspacePoolManager.Dispose method
KestrunRunspacePoolManager.Host property
KestrunRunspacePoolManager.MaxRunspaces property
KestrunRunspacePoolManager.MinRunspaces property
KestrunRunspacePoolManager.OpenApiClassesPath property
KestrunRunspacePoolManager.Release method
KestrunRunspacePoolManager.ThreadOptions property
LanguageRuntimeExtensions class
LanguageRuntimeExtensions.UseLanguageRuntime method
RouteHandlerBuilderLanguageExtensions class
RouteHandlerBuilderLanguageExtensions.WithLanguage method
ScriptLanguage enumeration
ScriptLanguageAttribute class
ScriptLanguageAttribute constructor
ScriptLanguageAttribute.Language property
Kestrun.SharedState
GlobalStore class
GlobalStore.Clear method
GlobalStore.Contains method
GlobalStore.Count property
GlobalStore.Get method
GlobalStore.Keys property
GlobalStore.KeySnapshot method
GlobalStore.Remove method
GlobalStore.Set method
GlobalStore.Snapshot method
GlobalStore.TryGet<T> method
GlobalStore.Values property
SharedState class
SharedState constructor
SharedState.Clear method
SharedState.Contains method
SharedState.Count property
SharedState.Get method
SharedState.Keys property
SharedState.KeySnapshot method
SharedState.Remove method
SharedState.Set method
SharedState.Snapshot method
SharedState.TryGet<T> method
SharedState.Values property
Kestrun.SignalR
IConnectionTracker interface
IConnectionTracker.ConnectedCount property
IConnectionTracker.GetConnections method
IConnectionTracker.OnConnected method
IConnectionTracker.OnDisconnected method
InMemoryConnectionTracker class
InMemoryConnectionTracker constructor
InMemoryConnectionTracker.ConnectedCount property
InMemoryConnectionTracker.GetConnections method
InMemoryConnectionTracker.OnConnected method
InMemoryConnectionTracker.OnDisconnected method
IRealtimeBroadcaster interface
IRealtimeBroadcaster.BroadcastEventAsync method
IRealtimeBroadcaster.BroadcastLogAsync method
IRealtimeBroadcaster.BroadcastToGroupAsync method
KestrunHub class
KestrunHub constructor
KestrunHub.Echo method
KestrunHub.JoinGroup method
KestrunHub.LeaveGroup method
KestrunHub.OnConnectedAsync method
KestrunHub.OnDisconnectedAsync method
RealtimeBroadcaster class
RealtimeBroadcaster constructor
RealtimeBroadcaster.BroadcastEventAsync method
RealtimeBroadcaster.BroadcastLogAsync method
RealtimeBroadcaster.BroadcastToGroupAsync method
Kestrun.Sse
InMemorySseBroadcaster class
InMemorySseBroadcaster constructor
InMemorySseBroadcaster.BroadcastAsync method
InMemorySseBroadcaster.ConnectedCount property
InMemorySseBroadcaster.Subscribe method
ISseBroadcaster interface
ISseBroadcaster.BroadcastAsync method
ISseBroadcaster.ConnectedCount property
ISseBroadcaster.Subscribe method
SseClientSubscription constructor
SseClientSubscription structure
SseClientSubscription.ClientId property
SseClientSubscription.Reader property
SseEventFormatter class
SseEventFormatter.Format method
SseEventFormatter.FormatComment method
Kestrun.Tasks
KestrunTask class
KestrunTask.Children property
KestrunTask.CompletedAtUtc property
KestrunTask.Description property
KestrunTask.Fault property
KestrunTask.Finished property
KestrunTask.Id property
KestrunTask.Name property
KestrunTask.Output property
KestrunTask.Parent property
KestrunTask.Progress property
KestrunTask.Runner property
KestrunTask.ScriptCode property
KestrunTask.StartedAtUtc property
KestrunTask.State property
KestrunTask.TokenSource property
KestrunTask.ToKrTask method
KestrunTask.Work property
KestrunTaskService class
KestrunTaskService constructor
KestrunTaskService.Cancel method
KestrunTaskService.Create method
KestrunTaskService.Dispose method
KestrunTaskService.Get method
KestrunTaskService.GetResult method
KestrunTaskService.GetState method
KestrunTaskService.List method
KestrunTaskService.Remove method
KestrunTaskService.SetTaskDescription method
KestrunTaskService.SetTaskName method
KestrunTaskService.Start method
KestrunTaskService.StartAsync method
KrTask constructor
KrTask record
KrTask.ChildrenId property
KrTask.CompletedAt property
KrTask.Description property
KrTask.Duration property
KrTask.Id property
KrTask.Name property
KrTask.ParentId property
KrTask.Progress property
KrTask.StartedAt property
KrTask.State property
KrTask.StateText property
ProgressiveKestrunTaskState class
ProgressiveKestrunTaskState constructor
ProgressiveKestrunTaskState.Cancel method
ProgressiveKestrunTaskState.Complete method
ProgressiveKestrunTaskState.Fail method
ProgressiveKestrunTaskState.PercentComplete property
ProgressiveKestrunTaskState.Reset method
ProgressiveKestrunTaskState.StatusMessage property
ProgressiveKestrunTaskState.ToString method
TaskState enumeration
Kestrun.TBuilder
EndpointConventionBuilderLanguageExtensions class
EndpointConventionBuilderLanguageExtensions.WithLanguage<TBuilder> method
EndpointDisablingCompressionExtensions class
EndpointDisablingCompressionExtensions.DisableResponseCompression<TBuilder> method
EndpointDisablingCompressionExtensions.DisableResponseCompressionKey field
Kestrun.Utilities
AssemblyAutoLoader class
AssemblyAutoLoader.Clear method
AssemblyAutoLoader.PreloadAll method
BuildError class
BuildError.ResponseAsync method
BuildError.Result method
BuildError.Text method
CcUtilities class
CcUtilities.GetLineNumber method
CcUtilities.PreviewFeaturesEnabled method
HostingExtensions class
HostingExtensions.RunUntilShutdownAsync method
HttpVerb enumeration
HttpVerbExtensions class
HttpVerbExtensions.FromMethodString method
HttpVerbExtensions.ToMethodString method
HttpVerbExtensions.TryFromMethodString method
KestrunLockRegistry class
KestrunLockRegistry.Default property
KestrunLockRegistry.GetOrCreate method
KestrunLockRegistry.TryGet method
ObjectToDictionaryConverter class
ObjectToDictionaryConverter.ToDictionary method
ObjectToDictionaryConverter.ToDictionaryObject method
PowerShellModuleLocator class
PowerShellModuleLocator.LocateKestrunModule method
RateLimiterOptionsExtensions class
RateLimiterOptionsExtensions.CopyFrom method
ReadOnlyDictionaryAdapter class
ReadOnlyDictionaryAdapter constructor
ReadOnlyDictionaryAdapter indexer
ReadOnlyDictionaryAdapter.ContainsKey method
ReadOnlyDictionaryAdapter.Count property
ReadOnlyDictionaryAdapter.GetEnumerator method
ReadOnlyDictionaryAdapter.Keys property
ReadOnlyDictionaryAdapter.TryGetValue method
ReadOnlyDictionaryAdapter.Values property
SecureStringUtils class
SecureStringUtils.SpanHandler delegate
SecureStringUtils.ToSecureSpan method
SecureStringUtils.ToSecureString method
XmlHelper class
XmlHelper.DefaultMaxDepth field
XmlHelper.MaxDepth property
XmlHelper.ToHashtable method
XmlHelper.ToXml method
Kestrun.Utilities.Json
JsonSerializerHelper class
JsonSerializerHelper.FromJson method (1 of 2)
PayloadSanitizer class
PayloadSanitizer.Sanitize method
Kestrun.Utilities.Yaml
BigIntegerTypeConverter class
BigIntegerTypeConverter constructor
BigIntegerTypeConverter.Accepts method
BigIntegerTypeConverter.ReadYaml method
BigIntegerTypeConverter.WriteYaml method
BuilderUtils class
BuilderUtils constructor
BuilderUtils.BuildSerializer method
FlowStyleAllEmitter class
FlowStyleAllEmitter constructor
FlowStyleAllEmitter.Emit method (1 of 2)
FlowStyleSequenceEmitter class
FlowStyleSequenceEmitter constructor
FlowStyleSequenceEmitter.Emit method
IDictionaryTypeConverter class
IDictionaryTypeConverter constructor
IDictionaryTypeConverter.Accepts method
IDictionaryTypeConverter.ReadYaml method
IDictionaryTypeConverter.WriteYaml method
NullValueGraphVisitor class
NullValueGraphVisitor constructor
NullValueGraphVisitor.EnterMapping method (1 of 2)
PSObjectTypeConverter class
PSObjectTypeConverter constructor
PSObjectTypeConverter.Accepts method
PSObjectTypeConverter.ReadYaml method
PSObjectTypeConverter.WriteYaml method
SerializationOptions enumeration
StringQuotingEmitter class
StringQuotingEmitter constructor
StringQuotingEmitter.Emit method
YamlHelper class
YamlHelper.ToYaml method
YamlLoader class
YamlLoader.DeserializeToObjects method
YamlLoader.GetRootNodes method
YamlLoader.GetYamlDocuments method
YamlSerializerFactory class
YamlSerializerFactory.GetSerializer method
YamlTypeConverter class
YamlTypeConverter.ConvertValueToProperType method
YamlTypeConverter.ConvertYamlDocumentToPSObject method (1 of 2)
YamlTypeConverter.ConvertYamlMappingToHashtable method
YamlTypeConverter.ConvertYamlSequenceToArray method
Guides
Antiforgery (CSRF) Protection
HTTP Caching
Certificates Management
Dotnet Tool
Production Deployment (Service/Daemon)
MCP Server
Production Deployment (Container)
Response Compression
CORS
ExceptionHandling
Localization
∞
Razor Localization
Forwarded Headers
Health Monitoring
HSTS and HTTPS Redirection
Authentication
Basic (PowerShell)
Basic (C# / VB.NET)
API Key
JWT Tokens
Cookies
Windows Authentication
Claims & Policies
Client Certificate
OpenID Connect (Okta)
Multiple Schemes
Client Certificate Authentication
GitHub Authentication
Full Demo
OpenID Connect (Duende Demo)
Full Demo
JWT Tokens
OAuth 2.0
OpenID Connect (OIDC)
Kestrun Logging
OpenAPI
Beginner
Components
Routing
Advanced
Callbacks and Webhooks
Runtime Contract Enforcement
Real-time (SSE & SignalR)
Routing & Conventions
Imperative vs Declarative Routing
Razor Pages
Scheduling
Client Sessions
File & Form Uploads
Shared State & Runspaces
Status Code Pages Middleware
Ad-hoc Tasks
Contributing
Build & Environment
Testing
Style & Quality
Git Workflow
Troubleshooting
Logging & Console Output
Tutorial Page Authoring Template
Kestrun on GitHub
Search Kestrun documentation
Repository
C#
C# API
Kestrun.Mcp
KestrunMcpError.Code property
KestrunMcpError.Code property
Stable error code.
public
string
Code
{
get
;
set
;
}
See Also
record
KestrunMcpError
namespace
Kestrun.Mcp