Configuration Reference

netty.default.allocator.num-heap-arenas

java.lang.Integer

The number of heap arenas

netty.default.allocator.num-direct-arenas

java.lang.Integer

The number of direct arenas

netty.default.allocator.page-size

java.lang.Integer

The page size

netty.default.allocator.max-order

java.lang.Integer

The max order

netty.default.allocator.chunk-size

java.lang.Integer

The chunk size

netty.default.allocator.small-cache-size

java.lang.Integer

The small cache size

netty.default.allocator.normal-cache-size

java.lang.Integer

The normal cache size

netty.default.allocator.use-cache-for-all-threads

java.lang.Boolean

Whether to use the cache for all threads

netty.default.allocator.max-cached-buffer-capacity

java.lang.Integer

The max cached buffer capacity

netty.default.allocator.cache-trim-interval

java.lang.Integer

The cache trim interval

netty.default.allocator.max-cached-byte-buffers-per-chunk

java.lang.Integer

The max cached byte buffers per chunk

micronaut.io.watch.enabled

boolean

Whether watch is enabled.

micronaut.io.watch.restart

boolean

Should the server be shutdown when a watch event fires. Note that if set to true an external process like {@code gradle run --continuous} or Kubernetes replication controller is required to restart the container.

micronaut.io.watch.paths

java.util.List

The paths to watch.

micronaut.io.watch.check-interval

java.time.Duration

The interval to wait between checks.

micronaut.application.default-charset

java.nio.charset.Charset

micronaut.application.name

java.lang.String

The application name. Used to identify the application for purposes of reporting, tracing, service discovery etc. Should be unique.

micronaut.executors.*.n-threads

java.lang.Integer

number of threads

micronaut.executors.*.type

ExecutorType

the type

micronaut.executors.*.parallelism

java.lang.Integer

the parallelism

micronaut.executors.*.core-pool-size

java.lang.Integer

the core pool size

micronaut.executors.*.virtual

java.lang.Boolean

whether to use virtual threads

micronaut.executors.*.thread-factory-class

java.lang.Class

the thread factory class

micronaut.executors.*.name

java.lang.String

Sets the executor name.

micronaut.executors.*.number-of-threads

java.lang.Integer

Sets the number of threads for FIXED. Default value (2 * Number of processors available to the Java virtual machine).

micronaut.application.instance.id

java.lang.String

micronaut.application.instance.metadata

java.util.Map

micronaut.application.instance.group

java.lang.String

micronaut.application.instance.zone

java.lang.String

micronaut.heartbeat.interval

java.time.Duration

micronaut.heartbeat.enabled

boolean

micronaut.application.digitalocean.metadata.enabled

boolean

micronaut.application.digitalocean.metadata.url

java.lang.String

micronaut.function.binary-types.use-defaults

boolean

If this is false then calls to {@link #isMediaTypeBinary(String)} will only check the additional types, and ignore the defaults. The defaults are: {@value MediaType#APPLICATION_OCTET_STREAM}, {@value MediaType#IMAGE_JPEG}, {@value MediaType#IMAGE_PNG}, {@value MediaType#IMAGE_GIF}, "application/zip"

micronaut.function.binary-types.additional-types

java.util.List

The additional media types to consider binary.

micronaut.http.services.*.ssl.key.password

java.lang.String

micronaut.http.services.*.ssl.key.alias

java.lang.String

micronaut.http.client.pool.enabled

boolean

Whether connection pooling is enabled. [available in the Netty HTTP client]

micronaut.http.client.pool.max-pending-acquires

int

Maximum number of futures awaiting connection acquisition. Defaults to no maximum. [available in the Netty HTTP client]

micronaut.http.client.pool.acquire-timeout

java.time.Duration

The time to wait to acquire a connection. [available in the Netty HTTP client]

micronaut.http.client.pool.max-pending-connections

int

The maximum number of <i>pending</i> (new) connections before they are assigned to a pool. [available in the Netty HTTP client]

micronaut.http.client.pool.max-concurrent-requests-per-http2-connection

int

The maximum number of requests (streams) that can run concurrently on one HTTP2 connection. [available in the Netty HTTP client]

micronaut.http.client.pool.max-concurrent-http1-connections

int

The maximum number of concurrent HTTP1 connections in the pool. [available in the Netty HTTP client]

micronaut.http.client.pool.max-concurrent-http2-connections

int

The maximum number of concurrent HTTP2 connections in the pool. [available in the Netty HTTP client]

micronaut.http.client.versioning.default.headers

java.util.List

micronaut.http.client.versioning.default.parameters

java.util.List

micronaut.http.services.*.pool.enabled

boolean

Whether connection pooling is enabled. [available in the Netty HTTP client]

micronaut.http.services.*.pool.max-pending-acquires

int

Maximum number of futures awaiting connection acquisition. Defaults to no maximum. [available in the Netty HTTP client]

micronaut.http.services.*.pool.acquire-timeout

java.time.Duration

The time to wait to acquire a connection. [available in the Netty HTTP client]

micronaut.http.services.*.pool.max-pending-connections

int

The maximum number of <i>pending</i> (new) connections before they are assigned to a pool. [available in the Netty HTTP client]

micronaut.http.services.*.pool.max-concurrent-requests-per-http2-connection

int

The maximum number of requests (streams) that can run concurrently on one HTTP2 connection. [available in the Netty HTTP client]

micronaut.http.services.*.pool.max-concurrent-http1-connections

int

The maximum number of concurrent HTTP1 connections in the pool. [available in the Netty HTTP client]

micronaut.http.services.*.pool.max-concurrent-http2-connections

int

The maximum number of concurrent HTTP2 connections in the pool. [available in the Netty HTTP client]

micronaut.http.services.*.ws.compression.enabled

boolean

Whether deflate compression is enabled for client WebSocket connections.

micronaut.http.services.*.ws.compression.ping-interval-read

java.time.Duration

For HTTP/2 connections, the interval from the last inbound message to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.services.*.ws.compression.ping-interval-write

java.time.Duration

For HTTP/2 connections, the interval from the last outbound message to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.services.*.ws.compression.ping-interval-idle

java.time.Duration

For HTTP/2 connections, the interval from the last message (inbound or outbound) to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.services.*.ssl-configuration

SslConfiguration

micronaut.http.services.*.ssl.enabled

boolean

micronaut.http.services.*.ssl.port

int

micronaut.http.services.*.ssl.client-authentication

ClientAuthentication

micronaut.http.services.*.ssl.ciphers

java.lang.String

micronaut.http.services.*.ssl.protocols

java.lang.String

micronaut.http.services.*.ssl.protocol

java.lang.String

micronaut.http.services.*.ssl.handshake-timeout

java.time.Duration

micronaut.http.services.*.ssl.build-self-signed

boolean

micronaut.http.services.*.ssl.prefer-openssl

boolean

micronaut.http.services.*.ssl.insecure-trust-all-certificates

boolean

micronaut.http.services.*.ssl.key-store.path

java.lang.String

micronaut.http.services.*.ssl.key-store.password

java.lang.String

micronaut.http.services.*.ssl.key-store.type

java.lang.String

micronaut.http.services.*.ssl.key-store.provider

java.lang.String

micronaut.http.client.http2.ping-interval-read

java.time.Duration

For HTTP/2 connections, the interval from the last inbound message to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.client.http2.ping-interval-write

java.time.Duration

For HTTP/2 connections, the interval from the last outbound message to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.client.http2.ping-interval-idle

java.time.Duration

For HTTP/2 connections, the interval from the last message (inbound or outbound) to when an automated ping should be sent. This can be used to keep low-traffic connections alive.

micronaut.http.client.versioning.*.headers

java.util.List

micronaut.http.client.versioning.*.parameters

java.util.List

micronaut.http.client.ws.compression.enabled

boolean

Whether deflate compression is enabled for client WebSocket connections.

micronaut.http.client.http-version

HttpVersion

The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.http.client.log-level

LogLevel

[available in the Netty HTTP client].

micronaut.http.client.event-loop-group

java.lang.String

[available in the Netty HTTP client].

micronaut.http.client.ssl-configuration

SslConfiguration

micronaut.http.client.follow-redirects

boolean

micronaut.http.client.exception-on-error-status

boolean

micronaut.http.client.logger-name

java.lang.String

micronaut.http.client.default-charset

java.nio.charset.Charset

[available in the Netty HTTP client].

micronaut.http.client.channel-options

java.util.Map

[available in the Netty HTTP client].

micronaut.http.client.read-timeout

java.time.Duration

micronaut.http.client.request-timeout

java.time.Duration

The request timeout for non-streaming requests. This is the maximum time until the response must be completely received. Defaults to one second more than read-timeout.

micronaut.http.client.read-idle-timeout

java.time.Duration

For WebSockets, the {@link #getReadTimeout()} method does not apply instead a configurable idle timeout is applied. [available in the Netty HTTP client]

micronaut.http.client.connection-pool-idle-timeout

java.time.Duration

[available in the Netty HTTP client].

micronaut.http.client.connect-timeout

java.time.Duration

micronaut.http.client.connect-ttl

java.time.Duration

[available in the Netty HTTP client].

micronaut.http.client.shutdown-quiet-period

java.time.Duration

The amount of quiet period for shutdown. [available in the Netty HTTP client]

micronaut.http.client.shutdown-timeout

java.time.Duration

The amount of time to wait for shutdown. [available in the Netty HTTP client]

micronaut.http.client.num-of-threads

java.lang.Integer

[available in the Netty HTTP client].

micronaut.http.client.thread-factory

java.lang.Class

[available in the Netty HTTP client].

micronaut.http.client.max-content-length

int

[available in the Netty HTTP client].

micronaut.http.client.proxy-type

java.net.Proxy$Type

<p>The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.</p>

<p>Alternatively configure a {@code java.net.ProxySelector}</p>

micronaut.http.client.proxy-address

java.net.SocketAddress

The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties. <p> Alternatively configure a {@code java.net.ProxySelector}

micronaut.http.client.proxy-username

java.lang.String

micronaut.http.client.proxy-password

java.lang.String

micronaut.http.client.proxy-selector

java.net.ProxySelector

micronaut.http.client.plaintext-mode

HttpVersionSelection$PlaintextMode

The connection mode to use for <i>plaintext</i> (http as opposed to https) connections. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b>

[available in the Netty HTTP client].

micronaut.http.client.alpn-modes

java.util.List

The protocols to support for TLS ALPN. If HTTP 2 is included, this will also restrict the TLS cipher suites to those supported by the HTTP 2 standard. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client].

micronaut.http.client.allow-block-event-loop

boolean

Whether to allow blocking a netty event loop with a call to {@link BlockingHttpClient}. When this is off (the default), any calls that block an event loop will throw an error. Such calls are almost always a mistake that can lead to hard-to-debug transient issues such as read timeouts. Only enable this setting if you are sure you won’t hit such a bug.

micronaut.http.client.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

Configure how DNS records are resolved. Ignored if {@link #getAddressResolverGroupName()} is non-null. This option is specific to the netty client.

micronaut.http.client.address-resolver-group-name

java.lang.String

Name of a fixed netty AddressResolverGroup to use for this client, or {@code null} to instead use {@link #getDnsResolutionMode()}. This option is specific to the netty client.

micronaut.http.client.pcap-logging-path-pattern

java.lang.String

The path pattern to use for logging outgoing connections to pcap. This is an unsupported option: Behavior may change, or it may disappear entirely, without notice! Only implemented for netty.

micronaut.http.services.*.ssl.trust-store.path

java.lang.String

micronaut.http.services.*.ssl.trust-store.password

java.lang.String

micronaut.http.services.*.ssl.trust-store.type

java.lang.String

micronaut.http.services.*.ssl.trust-store.provider

java.lang.String

micronaut.http.services.*.http-version

HttpVersion

The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.http.services.*.log-level

LogLevel

[available in the Netty HTTP client].

micronaut.http.services.*.event-loop-group

java.lang.String

[available in the Netty HTTP client].

micronaut.http.services.*.follow-redirects

boolean

micronaut.http.services.*.exception-on-error-status

boolean

micronaut.http.services.*.logger-name

java.lang.String

micronaut.http.services.*.default-charset

java.nio.charset.Charset

[available in the Netty HTTP client].

micronaut.http.services.*.channel-options

java.util.Map

[available in the Netty HTTP client].

micronaut.http.services.*.read-timeout

java.time.Duration

micronaut.http.services.*.request-timeout

java.time.Duration

The request timeout for non-streaming requests. This is the maximum time until the response must be completely received. Defaults to one second more than read-timeout.

micronaut.http.services.*.read-idle-timeout

java.time.Duration

For WebSockets, the {@link #getReadTimeout()} method does not apply instead a configurable idle timeout is applied. [available in the Netty HTTP client]

micronaut.http.services.*.connection-pool-idle-timeout

java.time.Duration

[available in the Netty HTTP client].

micronaut.http.services.*.connect-timeout

java.time.Duration

micronaut.http.services.*.connect-ttl

java.time.Duration

[available in the Netty HTTP client].

micronaut.http.services.*.shutdown-quiet-period

java.time.Duration

The amount of quiet period for shutdown. [available in the Netty HTTP client]

micronaut.http.services.*.shutdown-timeout

java.time.Duration

The amount of time to wait for shutdown. [available in the Netty HTTP client]

micronaut.http.services.*.num-of-threads

java.lang.Integer

[available in the Netty HTTP client].

micronaut.http.services.*.thread-factory

java.lang.Class

[available in the Netty HTTP client].

micronaut.http.services.*.max-content-length

int

[available in the Netty HTTP client].

micronaut.http.services.*.proxy-type

java.net.Proxy$Type

<p>The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.</p>

<p>Alternatively configure a {@code java.net.ProxySelector}</p>

micronaut.http.services.*.proxy-address

java.net.SocketAddress

The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties. <p> Alternatively configure a {@code java.net.ProxySelector}

micronaut.http.services.*.proxy-username

java.lang.String

micronaut.http.services.*.proxy-password

java.lang.String

micronaut.http.services.*.proxy-selector

java.net.ProxySelector

micronaut.http.services.*.plaintext-mode

HttpVersionSelection$PlaintextMode

The connection mode to use for <i>plaintext</i> (http as opposed to https) connections. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b>

[available in the Netty HTTP client].

micronaut.http.services.*.alpn-modes

java.util.List

The protocols to support for TLS ALPN. If HTTP 2 is included, this will also restrict the TLS cipher suites to those supported by the HTTP 2 standard. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client].

micronaut.http.services.*.allow-block-event-loop

boolean

Whether to allow blocking a netty event loop with a call to {@link BlockingHttpClient}. When this is off (the default), any calls that block an event loop will throw an error. Such calls are almost always a mistake that can lead to hard-to-debug transient issues such as read timeouts. Only enable this setting if you are sure you won’t hit such a bug.

micronaut.http.services.*.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

Configure how DNS records are resolved. Ignored if {@link #getAddressResolverGroupName()} is non-null. This option is specific to the netty client.

micronaut.http.services.*.address-resolver-group-name

java.lang.String

Name of a fixed netty AddressResolverGroup to use for this client, or {@code null} to instead use {@link #getDnsResolutionMode()}. This option is specific to the netty client.

micronaut.http.services.*.pcap-logging-path-pattern

java.lang.String

The path pattern to use for logging outgoing connections to pcap. This is an unsupported option: Behavior may change, or it may disappear entirely, without notice! Only implemented for netty.

micronaut.http.services.*.urls

java.util.List

The URLs.

micronaut.http.services.*.url

java.net.URI

Sets the URL of the service.

micronaut.http.services.*.health-check-uri

java.lang.String

The URI to check the service for health status.

micronaut.http.services.*.health-check

boolean

Whether the service health should be checked.

micronaut.http.services.*.path

java.lang.String

The context path to use for requests.

micronaut.http.services.*.health-check-interval

java.time.Duration

The default duration to check health status.

micronaut.server.ssl.enabled

boolean

micronaut.server.ssl.port

int

micronaut.server.ssl.client-authentication

ClientAuthentication

micronaut.server.ssl.ciphers

java.lang.String

micronaut.server.ssl.protocols

java.lang.String

micronaut.server.ssl.protocol

java.lang.String

micronaut.server.ssl.handshake-timeout

java.time.Duration

micronaut.server.ssl.prefer-openssl

boolean

Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default.

micronaut.server.ssl.build-self-signed

boolean

Sets whether to build a self-signed certificate. Default value (false).

micronaut.ssl.enabled

boolean

micronaut.ssl.port

int

micronaut.ssl.client-authentication

ClientAuthentication

micronaut.ssl.ciphers

java.lang.String

micronaut.ssl.protocols

java.lang.String

micronaut.ssl.protocol

java.lang.String

micronaut.ssl.handshake-timeout

java.time.Duration

micronaut.ssl.build-self-signed

boolean

Sets whether to build a self-signed certificate. Default value (false).

micronaut.ssl.prefer-openssl

boolean

Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default.

micronaut.http.client.ssl.enabled

boolean

micronaut.http.client.ssl.port

int

micronaut.http.client.ssl.client-authentication

ClientAuthentication

micronaut.http.client.ssl.ciphers

java.lang.String

micronaut.http.client.ssl.protocols

java.lang.String

micronaut.http.client.ssl.protocol

java.lang.String

micronaut.http.client.ssl.handshake-timeout

java.time.Duration

micronaut.http.client.ssl.build-self-signed

boolean

Sets whether to build a self-signed certificate. Default value (false).

micronaut.http.client.ssl.prefer-openssl

boolean

Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default.

micronaut.http.client.ssl.insecure-trust-all-certificates

boolean

micronaut.ssl.key.password

java.lang.String

micronaut.ssl.key.alias

java.lang.String

micronaut.http.client.ssl.key-store.path

java.lang.String

micronaut.http.client.ssl.key-store.password

java.lang.String

micronaut.http.client.ssl.key-store.type

java.lang.String

micronaut.http.client.ssl.key-store.provider

java.lang.String

micronaut.http.client.ssl.key-store

SslConfiguration$KeyStoreConfiguration

micronaut.ssl.trust-store.path

java.lang.String

micronaut.ssl.trust-store.password

java.lang.String

micronaut.ssl.trust-store.type

java.lang.String

micronaut.ssl.trust-store.provider

java.lang.String

micronaut.ssl.key-store.path

java.lang.String

micronaut.ssl.key-store.password

java.lang.String

micronaut.ssl.key-store.type

java.lang.String

micronaut.ssl.key-store.provider

java.lang.String

micronaut.http.client.ssl.trust-store.path

java.lang.String

micronaut.http.client.ssl.trust-store.password

java.lang.String

micronaut.http.client.ssl.trust-store.type

java.lang.String

micronaut.http.client.ssl.trust-store.provider

java.lang.String

micronaut.http.client.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

micronaut.server.ssl.key-store.path

java.lang.String

micronaut.server.ssl.key-store.password

java.lang.String

micronaut.server.ssl.key-store.type

java.lang.String

micronaut.server.ssl.key-store.provider

java.lang.String

micronaut.server.ssl.key-store

SslConfiguration$KeyStoreConfiguration

micronaut.http.client.ssl.key.password

java.lang.String

micronaut.http.client.ssl.key.alias

java.lang.String

micronaut.http.client.ssl.key

SslConfiguration$KeyConfiguration

micronaut.http.forms.max-decoded-key-value-parameters

int

micronaut.codec.*.additional-types

java.util.List

micronaut.server.ssl.trust-store.path

java.lang.String

micronaut.server.ssl.trust-store.password

java.lang.String

micronaut.server.ssl.trust-store.type

java.lang.String

micronaut.server.ssl.trust-store.provider

java.lang.String

micronaut.server.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

micronaut.server.ssl.key.password

java.lang.String

micronaut.server.ssl.key.alias

java.lang.String

micronaut.server.ssl.key

SslConfiguration$KeyConfiguration

micronaut.netty.event-loops.*.num-threads

int

The number of threads

micronaut.netty.event-loops.*.io-ratio

java.lang.Integer

The IO ratio (optional)

micronaut.netty.event-loops.*.prefer-native-transport

boolean

Whether native transport is to be preferred

micronaut.netty.event-loops.*.executor

java.lang.String

A named executor service to use for event loop threads (optional). This property is very specialized. In particular, it will <i>not</i> solve read timeouts or fix blocking operations on the event loop, in fact it may do the opposite. Don’t use unless you really know what this does.

micronaut.netty.event-loops.*.shutdown-quiet-period

java.time.Duration

The shutdown quiet period

micronaut.netty.event-loops.*.shutdown-timeout

java.time.Duration

The shutdown timeout (must be >= shutdownQuietPeriod)

netty.resource-leak-detector-level

io.netty.util.ResourceLeakDetector$Level

Provides the value set for the resource leak detection.

netty.default-thread-factory-reactor-non-blocking

boolean

Default value: true. If {@code true}, netty event loop threads will implement project reactor {@link reactor.core.scheduler.NonBlocking} by default. Because of that, any Project Reactor’s blocking operations throw an exception on those threads.

netty.default-thread-factory-daemon

boolean

Default value: false.

netty.default-thread-factory-priority

int

Default value: false.

micronaut.server.locale-resolution.fixed

java.util.Locale

micronaut.server.locale-resolution.session-attribute

java.lang.String

micronaut.server.locale-resolution.default-locale

java.util.Locale

micronaut.server.locale-resolution.cookie-name

java.lang.String

micronaut.server.locale-resolution.header

boolean

micronaut.server.multipart.location

java.io.File

micronaut.server.multipart.max-file-size

long

micronaut.server.multipart.enabled

boolean

The default multipart enabled setting is false for servlets, but effectively true for Netty. This method returns the value only if set by the user.

micronaut.server.multipart.disk

boolean

micronaut.server.multipart.mixed

boolean

micronaut.server.multipart.threshold

long

micronaut.server.http-version

HttpVersion

The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.server.thread-selection

ThreadSelection

micronaut.server.default-charset

java.nio.charset.Charset

micronaut.server.port

int

micronaut.server.host

java.lang.String

micronaut.server.read-timeout

java.lang.Integer

micronaut.server.max-request-size

long

micronaut.server.max-request-buffer-size

long

micronaut.server.read-idle-timeout

java.time.Duration

micronaut.server.write-idle-timeout

java.time.Duration

micronaut.server.idle-timeout

java.time.Duration

micronaut.server.server-header

java.lang.String

micronaut.server.date-header

boolean

micronaut.server.log-handled-exceptions

boolean

micronaut.server.client-address-header

java.lang.String

micronaut.server.context-path

java.lang.String

micronaut.server.dual-protocol

boolean

micronaut.server.http-to-https-redirect

boolean

micronaut.server.dispatch-options-requests

boolean

Set to true to dispatch OPTIONS requests. Default value (false.

micronaut.server.validate-url

boolean

micronaut.server.not-found-on-missing-body

boolean

micronaut.server.cors.enabled

boolean

micronaut.server.cors.localhost-pass-through

boolean

micronaut.server.cors.configurations

java.util.Map

micronaut.server.cors.single-header

boolean

micronaut.server.host-resolution.host-header

java.lang.String

micronaut.server.host-resolution.protocol-header

java.lang.String

micronaut.server.host-resolution.port-header

java.lang.String

micronaut.server.host-resolution.port-in-host

boolean

micronaut.server.host-resolution.allowed-hosts

java.util.List

micronaut.server.netty.access-logger.enabled

boolean

Returns whether the access logger is enabled.

micronaut.server.netty.access-logger.logger-name

java.lang.String

The logger name to use. Access logs will be logged at info level.

micronaut.server.netty.access-logger.log-format

java.lang.String

Returns the log format to use.

micronaut.server.netty.access-logger.exclusions

java.util.List

micronaut.server.netty.responses.file.cache-control.public

boolean

micronaut.server.netty.worker.event-loop-group

java.lang.String

Sets the name to use.

micronaut.server.netty.worker.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.worker.io-ratio

java.lang.Integer

micronaut.server.netty.worker.executor

java.lang.String

A named executor service to use for event loop threads (optional). This property is very specialized. In particular, it will <i>not</i> solve read timeouts or fix blocking operations on the event loop, in fact it may do the opposite. Don’t use unless you really know what this does.

micronaut.server.netty.worker.prefer-native-transport

boolean

Set whether to prefer the native transport if available

micronaut.server.netty.worker.shutdown-quiet-period

java.time.Duration

Set the shutdown quiet period

micronaut.server.netty.worker.shutdown-timeout

java.time.Duration

Set the shutdown timeout (must be >= shutdownQuietPeriod)

micronaut.server.netty.parent.event-loop-group

java.lang.String

Sets the name to use.

micronaut.server.netty.parent.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.parent.io-ratio

java.lang.Integer

micronaut.server.netty.parent.executor

java.lang.String

A named executor service to use for event loop threads (optional). This property is very specialized. In particular, it will <i>not</i> solve read timeouts or fix blocking operations on the event loop, in fact it may do the opposite. Don’t use unless you really know what this does.

micronaut.server.netty.parent.prefer-native-transport

boolean

Set whether to prefer the native transport if available

micronaut.server.netty.parent.shutdown-quiet-period

java.time.Duration

Set the shutdown quiet period

micronaut.server.netty.parent.shutdown-timeout

java.time.Duration

Set the shutdown timeout (must be >= shutdownQuietPeriod)

micronaut.server.netty.responses.file.cache-seconds

int

micronaut.server.netty.listeners.*.family

NettyHttpServerConfiguration$NettyListenerConfiguration$Family

The address family of this listener.

micronaut.server.netty.listeners.*.ssl

boolean

Whether to enable SSL on this listener. Also requires ssl.SslConfiguration#isEnabled() to be set.

micronaut.server.netty.listeners.*.host

java.lang.String

For TCP listeners, the host to bind to, or {@code null} to bind to all hosts.

micronaut.server.netty.listeners.*.port

int

The TCP port to bind to. May be {@code -1} to bind to a random port.

micronaut.server.netty.listeners.*.path

java.lang.String

For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte.

micronaut.server.netty.listeners.*.expose-default-routes

boolean

Whether to expose default routes on this listener.

micronaut.server.netty.listeners.*.fd

java.lang.Integer

The fixed file descriptor for this listener, or {@code null} if a new file descriptor should be opened (the default).

micronaut.server.netty.listeners.*.bind

boolean

Whether the server should bind to the socket. {@code true} by default. If set to {@code false}, the socket must already be bound and listening.

micronaut.server.netty.listeners.*.server-socket

boolean

Whether to create a server socket. This is on by default. Turning it off only makes sense in combination with {@link #acceptedFd}.

micronaut.server.netty.listeners.*.accepted-fd

java.lang.Integer

An already accepted socket fd that should be registered to this listener.

micronaut.server.netty.http2.header-table-size

java.lang.Long

Gets the {@code SETTINGS_HEADER_TABLE_SIZE} value. If unavailable, returns {@code null}.

micronaut.server.netty.http2.push-enabled

java.lang.Boolean

Gets the {@code SETTINGS_ENABLE_PUSH} value. If unavailable, returns {@code null}.

micronaut.server.netty.http2.max-concurrent-streams

java.lang.Long

Gets the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value. If unavailable, returns {@code null}.

micronaut.server.netty.http2.initial-window-size

java.lang.Integer

Gets the {@code SETTINGS_INITIAL_WINDOW_SIZE} value. If unavailable, returns {@code null}.

micronaut.server.netty.http2.max-frame-size

java.lang.Integer

Gets the {@code SETTINGS_MAX_FRAME_SIZE} value. If unavailable, returns {@code null}.

micronaut.server.netty.http2.max-header-list-size

java.lang.Long

Gets the {@code SETTINGS_MAX_HEADER_LIST_SIZE} value. If unavailable, returns {@code null}.

micronaut.server.netty.server-type

NettyHttpServerConfiguration$HttpServerType

micronaut.server.netty.close-on-expectation-failed

boolean

If a 100-continue response is detected but the content length is too large then true means close the connection. otherwise the connection will remain open and data will be consumed and discarded until the next request is received.

<p>only relevant when {@link HttpServerType#FULL_CONTENT} is set</p>

micronaut.server.netty.fallback-protocol

java.lang.String

micronaut.server.netty.log-level

io.netty.handler.logging.LogLevel

The server {@link LogLevel} to enable.

micronaut.server.netty.max-initial-line-length

int

The maximum length of the initial HTTP request line. Defaults to 4096.

micronaut.server.netty.max-header-size

int

The maximum size of an individual HTTP setter. Defaults to 8192.

micronaut.server.netty.max-chunk-size

int

The maximum chunk size. Defaults to 8192.

micronaut.server.netty.max-h2c-upgrade-request-size

int

The maximum size of the body of the HTTP1.1 request used to upgrade a connection to HTTP2 clear-text (h2c). This initial request cannot be streamed and is instead buffered in full, so the default value (8192) is relatively small. <i>If this value is too small for your use case, instead consider using an empty initial "upgrade request" (e.g. {@code OPTIONS /}), or switch to normal HTTP2.</i> <p> <i>Does not affect normal HTTP2 (TLS).</i>

micronaut.server.netty.chunked-supported

boolean

Whether chunked requests are supported.

micronaut.server.netty.use-native-transport

boolean

Whether to use netty’s native transport (epoll or kqueue) if available.

micronaut.server.netty.validate-headers

boolean

Whether to validate headers.

micronaut.server.netty.initial-buffer-size

int

The initial buffer size. Defaults to 128.

micronaut.server.netty.compression-threshold

int

The default compression threshold. Defaults to 1024. <p> A value {@code < 0} indicates compression should never be enabled.

micronaut.server.netty.compression-level

int

The default compression level. Default value (6).

micronaut.server.netty.max-zstd-encode-size

int

The default maximum size of data that can be encoded using the zstd algorithm. Default value (1024 * 1024 * 32).

micronaut.server.netty.child-options

java.util.Map

micronaut.server.netty.options

java.util.Map

micronaut.server.netty.keep-alive-on-server-error

boolean

micronaut.server.netty.pcap-logging-path-pattern

java.lang.String

The path pattern to use for logging incoming connections to pcap. This is an unsupported option: Behavior may change, or it may disappear entirely, without notice!

micronaut.server.netty.listeners

java.util.List

Get the explicit netty listener configurations, or {@code null} if they should be implicit.

micronaut.server.netty.eager-parsing

boolean

Parse incoming JSON data eagerly, before route binding. Default value {@value DEFAULT_EAGER_PARSING}.

micronaut.server.netty.json-buffer-max-components

int

Maximum number of buffers to keep around in JSON parsing before they should be consolidated. Defaults to 4096.

micronaut.server.netty.legacy-multiplex-handlers

boolean

Prior to 4.4.0, the Micronaut HTTP server used a multi-pipeline approach for handling HTTP/2 connections where every request got its own netty pipeline with HTTP/2 to HTTP/1.1 converters on the pipeline. This allowed for using mostly unchanged HTTP/1.1 in the request handling and any NettyServerCustomizers. <p> As of 4.4.0, this approach was replaced with a more performant HTTP/2-specific implementation. This means worse compatibility with HTTP/1.1-based code paths and customizers, however. Setting this option to {@code true} returns to the old behavior.

micronaut.server.netty.form-max-fields

int

The maximum number of form fields permitted in a request.

micronaut.server.netty.form-max-buffered-bytes

int

The maximum number of bytes the form / multipart decoders are allowed to buffer internally. This sets a limit on form field size.

micronaut.server.netty.http3.initial-max-data

int

QUIC initial_max_data setting, see RFC 9000.

micronaut.server.netty.http3.initial-max-stream-data-bidirectional-local

int

QUIC initial_max_stream_data_bidi_local setting, see RFC 9000.

micronaut.server.netty.http3.initial-max-stream-data-bidirectional-remote

int

QUIC initial_max_stream_data_bidi_remote setting, see RFC 9000.

micronaut.server.netty.http3.initial-max-streams-bidirectional

int

QUIC initial_max_streams_bidi setting, see RFC 9000.

jackson.bean-introspection-module

boolean

Whether the BeanIntrospection should be used for reflection free object serialialization/deserialialization.

jackson.module-scan

boolean

Whether Jackson modules should be scanned for.

jackson.serialization-inclusion

com.fasterxml.jackson.annotation.JsonInclude$Include

jackson.default-typing

com.fasterxml.jackson.databind.ObjectMapper$DefaultTyping

jackson.locale

java.util.Locale

jackson.time-zone

java.util.TimeZone

jackson.date-format

java.lang.String

jackson.array-size-threshold

int

jackson.property-naming-strategy

com.fasterxml.jackson.databind.PropertyNamingStrategy

jackson.always-serialize-errors-as-list

boolean

Whether _embedded.errors should always be serialized as list. If set to false, _embedded.errors with 1 element will be serialized as an object.

jackson.trim-strings

boolean

Whether strings should be trimmed when deserializing. If the resulting string is an empty string, then null will be applied instead.

jackson.serialization

java.util.Map

Sets the serialization features to use.

jackson.deserialization

java.util.Map

Sets the deserialization features to use.

jackson.mapper

java.util.Map

Sets the object mapper features to use.

jackson.parser

java.util.Map

Sets the parser features to use.

jackson.generator

java.util.Map

Sets the generator features to use.

jackson.factory

java.util.Map

Sets the factory features to use.

endpoints.loggers.write-sensitive

boolean

endpoints.health.service-ready-indicator-enabled

boolean

Whether the ServiceReadyHealthIndicator is enabled. Defaults to {@code true}.

endpoints.health.details-visible

DetailsVisibility

endpoints.*.enabled

java.lang.Boolean

endpoints.*.sensitive

java.lang.Boolean

endpoints.*.path

java.lang.String

Endpoint’s path. If not set the endpoint name is used as the path.

endpoints.health.status.http-mapping

java.util.Map

endpoints.health.discovery-client.enabled

boolean

Health indicator is enabled. Default is true.

endpoints.all.path

java.lang.String

endpoints.all.context-path

java.lang.String

endpoints.all.enabled

java.lang.Boolean

endpoints.all.sensitive

java.lang.Boolean

endpoints.all.port

java.lang.Integer

endpoints.health.disk-space.enabled

boolean

endpoints.health.disk-space.path

java.io.File

endpoints.health.disk-space.threshold

long

micronaut.router.versioning.header.names

java.util.List

micronaut.router.versioning.header.enabled

boolean

micronaut.router.versioning.enabled

boolean

micronaut.router.versioning.default-version

java.lang.String

micronaut.router.versioning.parameter.names

java.util.List

micronaut.router.versioning.parameter.enabled

boolean

micronaut.router.static-resources.*.enabled

boolean

micronaut.router.static-resources.*.mapping

java.lang.String

The static resource mapping.

micronaut.router.static-resources.*.paths

java.util.List

A list of paths either starting with classpath: or file:. You can serve files from anywhere on disk or the classpath. For example to serve static resources from src/main/resources/public, you would use classpath:public as the path.