KestrunHostMapExtensions.AddFormRoute method

Adds a POST route that parses form payloads using KrFormParser, injects the parsed payload into the runspace as $FormPayload, and then executes the provided PowerShell userScriptBlock. By default, only multipart/form-data is accepted; additional request content types (such as application/x-www-form-urlencoded and multipart/mixed) are opt-in via AllowedRequestContentTypes. This method also fills OpenAPI (unless disabled) so the route appears in generated OpenAPI documents.

public static KestrunHost AddFormRoute(this KestrunHost host, string pattern, 
    ScriptBlock userScriptBlock, KrFormOptions? formOptions, string[]? authorizationSchemes, 
    string[]? authorizationPolicies, string? corsPolicy, bool allowAnonymous)
parameter description
host The Kestrun host.
pattern The route pattern (e.g. /upload).
userScriptBlock The PowerShell scriptblock to execute after parsing.
formOptions Form parsing options (null uses defaults).
authorizationSchemes Authorization schemes (optional).
authorizationPolicies Authorization policies (optional).
corsPolicy CORS policy name (optional).
allowAnonymous Whether to allow anonymous access.

Return Value

The host for chaining.

See Also