Micronaut Servlet Configuration Reference

Every documented configuration property of Micronaut Servlet, with types, descriptions, and defaults.

Micronaut Servlet documentation

335 properties across 7 sections

Micronaut Http Poja Apache Config Properties

Configuration properties for ApacheRuntimeConfiguration

PropertyTypeDescription
poja.apache.enabledbooleanSets whether the Apache POJA runtime is enabled.

Configuration properties for ApacheServletConfiguration

PropertyTypeDescriptionDefault
poja.apache.input-buffer-sizeintThe size of the buffer that is used to read and parse the HTTP request (in bytes). Default value is 8192 (8Kb).8192
poja.apache.output-buffer-sizeintThe size of the buffer that is used to write the HTTP response (in bytes). Default value is 8192 (8Kb).8192
poja.apache.use-inherited-channelbooleanWhen true, the inherited channel will be used by if present. Otherwise, STDIN and STDOUT will be used.true

Micronaut Http Server Jdk Config Properties

Configuration properties for JdkHttpServerConfiguration

PropertyTypeDescription
micronaut.server.http-versionHttpVersion
micronaut.server.thread-selectionThreadSelection
micronaut.server.redispatch-non-blocking-onlyboolean
micronaut.server.default-charsetjava.nio.charset.Charset
micronaut.server.portint
micronaut.server.hostjava.lang.String
micronaut.server.read-timeoutjava.lang.Integer
micronaut.server.max-request-sizelong
micronaut.server.max-request-buffer-sizelong
micronaut.server.read-idle-timeoutjava.time.Duration
micronaut.server.write-idle-timeoutjava.time.Duration
micronaut.server.idle-timeoutjava.time.Duration
micronaut.server.server-headerjava.lang.String
micronaut.server.date-headerboolean
micronaut.server.log-handled-exceptionsboolean
micronaut.server.client-address-headerjava.lang.String
micronaut.server.context-pathjava.lang.String
micronaut.server.dual-protocolboolean
micronaut.server.http-to-https-redirectboolean
micronaut.server.dispatch-options-requestsboolean
micronaut.server.validate-urlboolean
micronaut.server.escape-html-urlboolean
micronaut.server.not-found-on-missing-bodyboolean
micronaut.server.semicolon-is-normal-charboolean
micronaut.server.max-paramsint
micronaut.server.jdk.enabledbooleanSets whether the JDK HTTP server runtime is enabled.

Micronaut Http Server Jetty Config Properties

Configuration properties for JettyConfiguration

PropertyTypeDescription
micronaut.server.http-versionHttpVersion
micronaut.server.thread-selectionThreadSelection
micronaut.server.redispatch-non-blocking-onlyboolean
micronaut.server.default-charsetjava.nio.charset.Charset
micronaut.server.portint
micronaut.server.hostjava.lang.String
micronaut.server.read-timeoutjava.lang.Integer
micronaut.server.max-request-sizelong
micronaut.server.max-request-buffer-sizelong
micronaut.server.read-idle-timeoutjava.time.Duration
micronaut.server.write-idle-timeoutjava.time.Duration
micronaut.server.idle-timeoutjava.time.Duration
micronaut.server.server-headerjava.lang.String
micronaut.server.date-headerboolean
micronaut.server.log-handled-exceptionsboolean
micronaut.server.client-address-headerjava.lang.String
micronaut.server.context-pathjava.lang.String
micronaut.server.dual-protocolboolean
micronaut.server.http-to-https-redirectboolean
micronaut.server.dispatch-options-requestsboolean
micronaut.server.validate-urlboolean
micronaut.server.escape-html-urlboolean
micronaut.server.not-found-on-missing-bodyboolean
micronaut.server.semicolon-is-normal-charboolean
micronaut.server.max-paramsint
micronaut.server.jetty.enabledbooleanSets whether the Jetty runtime is enabled.
micronaut.server.jetty.init-parametersjava.util.MapSets the servlet init parameters.

Configuration properties for HttpConfiguration

PropertyTypeDescription
micronaut.server.jetty.customizersjava.util.List
micronaut.server.jetty.input-buffer-sizeint
micronaut.server.jetty.output-buffer-sizeint
micronaut.server.jetty.output-aggregation-sizeint
micronaut.server.jetty.request-header-sizeint
micronaut.server.jetty.response-header-sizeint
micronaut.server.jetty.max-response-header-sizeint
micronaut.server.jetty.header-cache-sizeint
micronaut.server.jetty.header-cache-case-sensitiveboolean
micronaut.server.jetty.secure-portint
micronaut.server.jetty.secure-schemejava.lang.String
micronaut.server.jetty.persistent-connections-enabledboolean
micronaut.server.jetty.idle-timeoutlong
micronaut.server.jetty.send-server-versionboolean
micronaut.server.jetty.send-xpowered-byboolean
micronaut.server.jetty.send-date-headerboolean
micronaut.server.jetty.use-input-direct-byte-buffersboolean
micronaut.server.jetty.use-output-direct-byte-buffersboolean
micronaut.server.jetty.form-encoded-methodsjava.lang.String
micronaut.server.jetty.max-error-dispatchesint
micronaut.server.jetty.min-input-buffer-spaceint
micronaut.server.jetty.min-request-data-ratelong
micronaut.server.jetty.min-response-data-ratelong
micronaut.server.jetty.http-complianceorg.eclipse.jetty.http.HttpCompliance
micronaut.server.jetty.uri-complianceorg.eclipse.jetty.http.UriCompliance
micronaut.server.jetty.redirect-uri-complianceorg.eclipse.jetty.http.UriCompliance
micronaut.server.jetty.request-cookie-complianceorg.eclipse.jetty.http.CookieCompliance
micronaut.server.jetty.response-cookie-complianceorg.eclipse.jetty.http.CookieCompliance
micronaut.server.jetty.multi-part-complianceorg.eclipse.jetty.http.MultiPartCompliance
micronaut.server.jetty.notify-forbidden-compliance-violationsboolean
micronaut.server.jetty.notify-remote-async-errorsboolean
micronaut.server.jetty.relative-redirect-allowedboolean
micronaut.server.jetty.generate-redirect-bodyboolean
micronaut.server.jetty.local-addressjava.net.SocketAddress
micronaut.server.jetty.server-authorityorg.eclipse.jetty.util.HostPort
micronaut.server.jetty.max-unconsumed-request-content-readsint

Configuration properties for HttpConfiguration

PropertyTypeDescription
micronaut.server.jetty.customizersjava.util.List
micronaut.server.jetty.input-buffer-sizeint
micronaut.server.jetty.output-buffer-sizeint
micronaut.server.jetty.output-aggregation-sizeint
micronaut.server.jetty.request-header-sizeint
micronaut.server.jetty.response-header-sizeint
micronaut.server.jetty.max-response-header-sizeint
micronaut.server.jetty.header-cache-sizeint
micronaut.server.jetty.header-cache-case-sensitiveboolean
micronaut.server.jetty.secure-portint
micronaut.server.jetty.secure-schemejava.lang.String
micronaut.server.jetty.persistent-connections-enabledboolean
micronaut.server.jetty.idle-timeoutlong
micronaut.server.jetty.send-server-versionboolean
micronaut.server.jetty.send-xpowered-byboolean
micronaut.server.jetty.send-date-headerboolean
micronaut.server.jetty.use-input-direct-byte-buffersboolean
micronaut.server.jetty.use-output-direct-byte-buffersboolean
micronaut.server.jetty.form-encoded-methodsjava.lang.String
micronaut.server.jetty.max-error-dispatchesint
micronaut.server.jetty.min-input-buffer-spaceint
micronaut.server.jetty.min-request-data-ratelong
micronaut.server.jetty.min-response-data-ratelong
micronaut.server.jetty.http-complianceorg.eclipse.jetty.http.HttpCompliance
micronaut.server.jetty.uri-complianceorg.eclipse.jetty.http.UriCompliance
micronaut.server.jetty.redirect-uri-complianceorg.eclipse.jetty.http.UriCompliance
micronaut.server.jetty.request-cookie-complianceorg.eclipse.jetty.http.CookieCompliance
micronaut.server.jetty.response-cookie-complianceorg.eclipse.jetty.http.CookieCompliance
micronaut.server.jetty.multi-part-complianceorg.eclipse.jetty.http.MultiPartCompliance
micronaut.server.jetty.notify-forbidden-compliance-violationsboolean
micronaut.server.jetty.notify-remote-async-errorsboolean
micronaut.server.jetty.relative-redirect-allowedboolean
micronaut.server.jetty.generate-redirect-bodyboolean
micronaut.server.jetty.local-addressjava.net.SocketAddress
micronaut.server.jetty.server-authorityorg.eclipse.jetty.util.HostPort
micronaut.server.jetty.max-unconsumed-request-content-readsint

Configuration properties for JettyConfiguration$JettyRequestLog

PropertyTypeDescription
micronaut.server.jetty.access-log.file-namejava.lang.Stringsets the fileName attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.
micronaut.server.jetty.access-log.enabledbooleanWhether access log is enabled.
micronaut.server.jetty.access-log.resource-pathjava.lang.Stringsets the resourcePath attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.
micronaut.server.jetty.access-log.quietbooleansets the quiet attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.
micronaut.server.jetty.access-log.patternjava.lang.StringSets the pattern to use for the access log. Defaults to CustomRequestLog.EXTENDED_NCSA_FORMAT.

Configuration properties for RequestLogWriter

PropertyTypeDescription
micronaut.server.jetty.access-log.filenamejava.lang.String
micronaut.server.jetty.access-log.retain-daysint
micronaut.server.jetty.access-log.appendboolean
micronaut.server.jetty.access-log.filename-date-formatjava.lang.String
micronaut.server.jetty.access-log.time-zonejava.lang.String

Configuration properties for JettyConfiguration$ConnectorConfiguration

PropertyTypeDescription
micronaut.server.jetty.connectors.*.idle-timeoutlong
micronaut.server.jetty.connectors.*.shutdown-idle-timeoutlong
micronaut.server.jetty.connectors.*.acceptingboolean
micronaut.server.jetty.connectors.*.acceptor-priority-deltaint
micronaut.server.jetty.connectors.*.default-protocoljava.lang.String
micronaut.server.jetty.connectors.*.namejava.lang.String
micronaut.server.jetty.connectors.*.hostjava.lang.String
micronaut.server.jetty.connectors.*.portint
micronaut.server.jetty.connectors.*.inherit-channelboolean
micronaut.server.jetty.connectors.*.accept-queue-sizeint
micronaut.server.jetty.connectors.*.reuse-addressboolean
micronaut.server.jetty.connectors.*.reuse-portboolean
micronaut.server.jetty.connectors.*.accepted-tcp-no-delayboolean
micronaut.server.jetty.connectors.*.accepted-receive-buffer-sizeint
micronaut.server.jetty.connectors.*.accepted-send-buffer-sizeint
micronaut.server.jetty.connectors.*.ssl-enabledbooleanSet whether SSL should be used if configured.

Configuration properties for JettyConfiguration$JettySslConfiguration

PropertyTypeDescription
micronaut.server.jetty.ssl.sni-host-checkboolean
micronaut.server.jetty.ssl.sni-requiredboolean
micronaut.server.jetty.ssl.sts-max-agelong
micronaut.server.jetty.ssl.sts-include-sub-domainsboolean

Micronaut Http Server Tomcat Config Properties

Configuration properties for TomcatConfiguration

PropertyTypeDescription
micronaut.server.http-versionHttpVersion
micronaut.server.thread-selectionThreadSelection
micronaut.server.redispatch-non-blocking-onlyboolean
micronaut.server.default-charsetjava.nio.charset.Charset
micronaut.server.portint
micronaut.server.hostjava.lang.String
micronaut.server.read-timeoutjava.lang.Integer
micronaut.server.max-request-sizelong
micronaut.server.max-request-buffer-sizelong
micronaut.server.read-idle-timeoutjava.time.Duration
micronaut.server.write-idle-timeoutjava.time.Duration
micronaut.server.idle-timeoutjava.time.Duration
micronaut.server.server-headerjava.lang.String
micronaut.server.date-headerboolean
micronaut.server.log-handled-exceptionsboolean
micronaut.server.client-address-headerjava.lang.String
micronaut.server.context-pathjava.lang.String
micronaut.server.dual-protocolboolean
micronaut.server.http-to-https-redirectboolean
micronaut.server.dispatch-options-requestsboolean
micronaut.server.validate-urlboolean
micronaut.server.escape-html-urlboolean
micronaut.server.not-found-on-missing-bodyboolean
micronaut.server.semicolon-is-normal-charboolean
micronaut.server.max-paramsint
micronaut.server.tomcat.protocoljava.lang.StringThe protocol to use. Defaults to org.apache.coyote.http11.Http11NioProtocol.
micronaut.server.tomcat.enabledbooleanSets whether the Tomcat runtime is enabled.

Configuration properties for Connector

PropertyTypeDescription
micronaut.server.tomcat.throw-on-failureboolean
micronaut.server.tomcat.domainjava.lang.String
micronaut.server.tomcat.serviceorg.apache.catalina.Service
micronaut.server.tomcat.allow-backslashboolean
micronaut.server.tomcat.allow-traceboolean
micronaut.server.tomcat.async-timeoutlong
micronaut.server.tomcat.discard-facadesboolean
micronaut.server.tomcat.enable-lookupsboolean
micronaut.server.tomcat.enforce-encoding-in-get-writerboolean
micronaut.server.tomcat.max-cookie-countint
micronaut.server.tomcat.max-parameter-countint
micronaut.server.tomcat.max-part-countint
micronaut.server.tomcat.max-part-header-sizeint
micronaut.server.tomcat.max-post-sizeint
micronaut.server.tomcat.max-save-post-sizeint
micronaut.server.tomcat.parse-body-methodsjava.lang.String
micronaut.server.tomcat.portint
micronaut.server.tomcat.port-offsetint
micronaut.server.tomcat.proxy-namejava.lang.String
micronaut.server.tomcat.proxy-portint
micronaut.server.tomcat.redirect-portint
micronaut.server.tomcat.schemejava.lang.String
micronaut.server.tomcat.secureboolean
micronaut.server.tomcat.uriencodingjava.lang.String
micronaut.server.tomcat.use-body-encoding-for-uriboolean
micronaut.server.tomcat.xpowered-byboolean
micronaut.server.tomcat.use-ipvhostsboolean
micronaut.server.tomcat.encoded-reverse-solidus-handlingjava.lang.String
micronaut.server.tomcat.encoded-solidus-handlingjava.lang.String
micronaut.server.tomcat.reject-suspicious-urisboolean

Configuration properties for Connector

PropertyTypeDescription
micronaut.server.tomcat.throw-on-failureboolean
micronaut.server.tomcat.domainjava.lang.String
micronaut.server.tomcat.serviceorg.apache.catalina.Service
micronaut.server.tomcat.allow-backslashboolean
micronaut.server.tomcat.allow-traceboolean
micronaut.server.tomcat.async-timeoutlong
micronaut.server.tomcat.discard-facadesboolean
micronaut.server.tomcat.enable-lookupsboolean
micronaut.server.tomcat.enforce-encoding-in-get-writerboolean
micronaut.server.tomcat.max-cookie-countint
micronaut.server.tomcat.max-parameter-countint
micronaut.server.tomcat.max-part-countint
micronaut.server.tomcat.max-part-header-sizeint
micronaut.server.tomcat.max-post-sizeint
micronaut.server.tomcat.max-save-post-sizeint
micronaut.server.tomcat.parse-body-methodsjava.lang.String
micronaut.server.tomcat.portint
micronaut.server.tomcat.port-offsetint
micronaut.server.tomcat.proxy-namejava.lang.String
micronaut.server.tomcat.proxy-portint
micronaut.server.tomcat.redirect-portint
micronaut.server.tomcat.schemejava.lang.String
micronaut.server.tomcat.secureboolean
micronaut.server.tomcat.uriencodingjava.lang.String
micronaut.server.tomcat.use-body-encoding-for-uriboolean
micronaut.server.tomcat.xpowered-byboolean
micronaut.server.tomcat.use-ipvhostsboolean
micronaut.server.tomcat.encoded-reverse-solidus-handlingjava.lang.String
micronaut.server.tomcat.encoded-solidus-handlingjava.lang.String
micronaut.server.tomcat.reject-suspicious-urisboolean

Configuration properties for TomcatConfiguration$AccessLogConfiguration

PropertyTypeDescription
micronaut.server.tomcat.access-log.throw-on-failureboolean
micronaut.server.tomcat.access-log.domainjava.lang.String
micronaut.server.tomcat.access-log.async-supportedboolean
micronaut.server.tomcat.access-log.max-log-message-buffer-sizeint
micronaut.server.tomcat.access-log.ipv6-canonicalboolean
micronaut.server.tomcat.access-log.request-attributes-enabledboolean
micronaut.server.tomcat.access-log.enabledboolean
micronaut.server.tomcat.access-log.patternjava.lang.String
micronaut.server.tomcat.access-log.conditionjava.lang.String
micronaut.server.tomcat.access-log.condition-unlessjava.lang.String
micronaut.server.tomcat.access-log.condition-ifjava.lang.String
micronaut.server.tomcat.access-log.localejava.lang.String
micronaut.server.tomcat.access-log.max-daysint
micronaut.server.tomcat.access-log.directoryjava.lang.String
micronaut.server.tomcat.access-log.check-existsboolean
micronaut.server.tomcat.access-log.prefixjava.lang.String
micronaut.server.tomcat.access-log.rotatableboolean
micronaut.server.tomcat.access-log.rename-on-rotateboolean
micronaut.server.tomcat.access-log.bufferedboolean
micronaut.server.tomcat.access-log.suffixjava.lang.String
micronaut.server.tomcat.access-log.file-date-formatjava.lang.String
micronaut.server.tomcat.access-log.encodingjava.lang.String

Micronaut Http Server Undertow Config Properties

Configuration properties for UndertowConfiguration

PropertyTypeDescription
micronaut.server.http-versionHttpVersion
micronaut.server.thread-selectionThreadSelection
micronaut.server.redispatch-non-blocking-onlyboolean
micronaut.server.default-charsetjava.nio.charset.Charset
micronaut.server.portint
micronaut.server.hostjava.lang.String
micronaut.server.read-timeoutjava.lang.Integer
micronaut.server.max-request-sizelong
micronaut.server.max-request-buffer-sizelong
micronaut.server.read-idle-timeoutjava.time.Duration
micronaut.server.write-idle-timeoutjava.time.Duration
micronaut.server.idle-timeoutjava.time.Duration
micronaut.server.server-headerjava.lang.String
micronaut.server.date-headerboolean
micronaut.server.log-handled-exceptionsboolean
micronaut.server.client-address-headerjava.lang.String
micronaut.server.context-pathjava.lang.String
micronaut.server.dual-protocolboolean
micronaut.server.http-to-https-redirectboolean
micronaut.server.dispatch-options-requestsboolean
micronaut.server.validate-urlboolean
micronaut.server.escape-html-urlboolean
micronaut.server.not-found-on-missing-bodyboolean
micronaut.server.semicolon-is-normal-charboolean
micronaut.server.max-paramsint
micronaut.server.undertow.enabledbooleanSets whether the Undertow runtime is enabled.
micronaut.server.undertow.worker-optionsjava.util.MapSets the worker options.
micronaut.server.undertow.socket-optionsjava.util.MapSets the socket options.
micronaut.server.undertow.server-optionsjava.util.MapThe server options.

Configuration properties for Undertow$Builder

PropertyTypeDescription
micronaut.server.undertow.buffer-sizeint
micronaut.server.undertow.io-threadsint
micronaut.server.undertow.worker-threadsint
micronaut.server.undertow.direct-buffersboolean
micronaut.server.undertow.handlerio.undertow.server.HttpHandler
micronaut.server.undertow.workerorg.xnio.XnioWorker
micronaut.server.undertow.ssl-engine-delegated-task-executorjava.util.concurrent.Executor
micronaut.server.undertow.byte-buffer-poolio.undertow.connector.ByteBufferPool

Configuration properties for Undertow$Builder

PropertyTypeDescription
micronaut.server.undertow.buffer-sizeint
micronaut.server.undertow.io-threadsint
micronaut.server.undertow.worker-threadsint
micronaut.server.undertow.direct-buffersboolean
micronaut.server.undertow.handlerio.undertow.server.HttpHandler
micronaut.server.undertow.workerorg.xnio.XnioWorker
micronaut.server.undertow.ssl-engine-delegated-task-executorjava.util.concurrent.Executor
micronaut.server.undertow.byte-buffer-poolio.undertow.connector.ByteBufferPool

Configuration properties for UndertowConfiguration$AccessLogConfiguration

PropertyTypeDescription
micronaut.server.undertow.access-log.enabledbooleanSets whether enabled.
micronaut.server.undertow.access-log.patternjava.lang.StringSets the underlow log pattern. <p>See https://undertow.io/javadoc/1.4.x/io/undertow/server/handlers/accesslog/AccessLogHandler.html for more.</p>

Configuration properties for DefaultAccessLogReceiver$Builder

PropertyTypeDescription
micronaut.server.undertow.access-log.output-directoryjava.nio.file.Path
micronaut.server.undertow.access-log.log-base-namejava.lang.String
micronaut.server.undertow.access-log.log-name-suffixjava.lang.String
micronaut.server.undertow.access-log.rotateboolean

Configuration properties for DefaultAccessLogReceiver$Builder

PropertyTypeDescription
micronaut.server.undertow.access-log.output-directoryjava.nio.file.Path
micronaut.server.undertow.access-log.log-base-namejava.lang.String
micronaut.server.undertow.access-log.log-name-suffixjava.lang.String
micronaut.server.undertow.access-log.rotateboolean

Micronaut Servlet Core Config Properties

Configuration properties for ServletStaticResourceConfiguration

PropertyTypeDescriptionDefault
micronaut.router.static-resources.*.mappingjava.lang.StringThe mapping/**
micronaut.router.static-resources.*.pathsjava.util.ListThe paths
micronaut.router.static-resources.*.enabledbooleantrue
micronaut.router.static-resources.*.cache-controljava.lang.StringFor Jetty based servers, allow configuring the cache control header for static resource mappings (defaults to "private,max-age=60").private,max-age=60

Micronaut Servlet Engine Config Properties

Configuration properties for MicronautServletConfiguration

PropertyTypeDescriptionDefault
micronaut.servlet.namejava.lang.StringThe name of the servletmicronaut
micronaut.servlet.mappingjava.lang.StringThe servlet mapping/*
micronaut.servlet.async-supportedbooleanSet whether async is supported or not.
micronaut.servlet.test-async-supportedjava.lang.BooleanLegacy property to disable async for testing.
micronaut.servlet.enable-virtual-threadsbooleanWhether virtual threads are enabled.
micronaut.servlet.async-file-serving-enabledbooleanIs async file serving enabled.
micronaut.servlet.min-threadsjava.lang.IntegerSpecify the minimum number of threads in the created thread pool.
micronaut.servlet.max-threadsjava.lang.IntegerSpecify the maximum number of threads in the created thread pool.