Micronaut Core Configuration Reference

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

Micronaut Core documentation

338 properties across 13 sections

Buffer Netty Config Properties

Configuration properties for DefaultByteBufAllocatorConfiguration

PropertyTypeDescription
netty.default.allocator.num-heap-arenasjava.lang.IntegerThe number of heap arenas
netty.default.allocator.num-direct-arenasjava.lang.IntegerThe number of direct arenas
netty.default.allocator.page-sizejava.lang.IntegerThe page size
netty.default.allocator.max-orderjava.lang.IntegerThe max order
netty.default.allocator.chunk-sizejava.lang.IntegerThe chunk size
netty.default.allocator.small-cache-sizejava.lang.IntegerThe small cache size
netty.default.allocator.normal-cache-sizejava.lang.IntegerThe normal cache size
netty.default.allocator.use-cache-for-all-threadsjava.lang.BooleanWhether to use the cache for all threads
netty.default.allocator.max-cached-buffer-capacityjava.lang.IntegerThe max cached buffer capacity
netty.default.allocator.cache-trim-intervaljava.lang.IntegerThe cache trim interval
netty.default.allocator.max-cached-byte-buffers-per-chunkjava.lang.IntegerThe max cached byte buffers per chunk

Context Config Properties

Configuration properties for InstanceConfiguration

PropertyTypeDescription
micronaut.application.instanceApplicationConfiguration$InstanceConfigurationThe instance configuration
micronaut.application.instance.idjava.lang.StringThe instance identifier
micronaut.application.instance.groupjava.lang.StringThe instance auto scaling group
micronaut.application.instance.zonejava.lang.StringThe instance availability zone
micronaut.application.instance.metadatajava.util.MapThe metadata to associate with the instance

Configuration properties for FileWatchConfiguration

PropertyTypeDescription
micronaut.io.watch.enabledbooleanWhether watch is enabled.
micronaut.io.watch.restartbooleanSet whether restart is enabled.
micronaut.io.watch.pathsjava.util.ListSets the watch paths to use.
micronaut.io.watch.check-intervaljava.time.DurationSets the interval to wait between file watch polls.

Configuration properties for ApplicationConfiguration

PropertyTypeDescription
micronaut.application.default-charsetjava.nio.charset.CharsetDefault value (UTF-8).
micronaut.application.namejava.lang.StringSet the application name

Configuration properties for UserExecutorConfiguration

PropertyTypeDescription
micronaut.executors.*.n-threadsjava.lang.Integer
micronaut.executors.*.typeExecutorType
micronaut.executors.*.parallelismjava.lang.Integer
micronaut.executors.*.core-pool-sizejava.lang.Integer
micronaut.executors.*.thread-factory-classjava.lang.Class
micronaut.executors.*.namejava.lang.StringSets the executor name.
micronaut.executors.*.number-of-threadsjava.lang.IntegerSets the number of threads for FIXED . Default value (2 * Number of processors available to the Java virtual machine).

Http Client Core Config Properties

Configuration properties for DefaultKeyStoreConfiguration

PropertyTypeDescription
micronaut.http.services.*.ssl.key-storeSslConfiguration$KeyStoreConfiguration
micronaut.http.services.*.ssl.key-store.pathjava.lang.String
micronaut.http.services.*.ssl.key-store.passwordjava.lang.String
micronaut.http.services.*.ssl.key-store.typejava.lang.String
micronaut.http.services.*.ssl.key-store.providerjava.lang.String

Configuration properties for DefaultConnectionPoolConfiguration

PropertyTypeDescription
micronaut.http.client.pool.enabledbooleanSets whether connection pooling is enabled. Default value (false).
micronaut.http.client.pool.max-connectionsintSets the maximum number of connections. Defaults to no maximum.
micronaut.http.client.pool.max-pending-acquiresintSets the max pending acquires.
micronaut.http.client.pool.acquire-timeoutjava.time.DurationSets the timeout to wait for a connection.

Configuration properties for DefaultClientVersioningConfiguration

PropertyTypeDescription
micronaut.http.client.versioning.default.headersjava.util.ListThe list of request header names.
micronaut.http.client.versioning.default.parametersjava.util.ListThe list of request query parameter names.

Configuration properties for DefaultHttpClientConfiguration

PropertyTypeDescription
micronaut.http.client.http-versionHttpVersionSets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.
micronaut.http.client.log-levelLogLevelSets the level to enable trace logging at. Depending on the implementation this may activate additional handlers. For example in Netty this will activate {@code LoggingHandler} at the given level.
micronaut.http.client.event-loop-groupjava.lang.StringSets the event loop group to use for the client.
micronaut.http.client.ssl-configurationSslConfigurationSets the SSL configuration for the client.
micronaut.http.client.exception-on-error-statusbooleanSets whether throwing an exception upon HTTP error status (>= 400) is preferred. Default value ( DEFAULT_EXCEPTION_ON_ERROR_STATUS )
micronaut.http.client.logger-namejava.lang.StringSets the client-specific logger name.
micronaut.http.client.follow-redirectsbooleanSets whether redirects should be followed. Default value ( DEFAULT_FOLLOW_REDIRECTS ).
micronaut.http.client.default-charsetjava.nio.charset.CharsetSets the default charset to use. Default value (UTF-8);
micronaut.http.client.channel-optionsjava.util.MapThe Client channel options
micronaut.http.client.shutdown-quiet-periodjava.time.DurationSets the amount of quiet period for shutdown of client thread pools. Default value (1 milliseconds). If a task is submitted during the quiet period, it will be accepted and the quiet period will start over.
micronaut.http.client.shutdown-timeoutjava.time.DurationSets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).
micronaut.http.client.read-timeoutjava.time.DurationSets the read timeout. Default value (10 seconds).
micronaut.http.client.read-idle-timeoutjava.time.DurationSets the max read idle time for streaming requests. Default value (5 minutes).
micronaut.http.client.connection-pool-idle-timeoutjava.time.DurationSets the idle timeout for connection in the client connection pool. Defaults to 0.
micronaut.http.client.connect-timeoutjava.time.DurationSets the connect timeout.
micronaut.http.client.connect-ttljava.time.DurationSets the connect timeout.
micronaut.http.client.num-of-threadsjava.lang.IntegerSets the number of threads the client should use for requests.
micronaut.http.client.thread-factoryjava.lang.ClassSets a thread factory.
micronaut.http.client.max-content-lengthintSets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).
micronaut.http.client.proxy-typejava.net.Proxy$TypeThe proxy type
micronaut.http.client.proxy-addressjava.net.SocketAddressSets a proxy address.
micronaut.http.client.proxy-usernamejava.lang.StringSets the proxy user name to use.
micronaut.http.client.proxy-passwordjava.lang.StringSets the proxy password.
micronaut.http.client.proxy-selectorjava.net.ProxySelectorSets the proxy selector. ProxySelector decides what proxy to use and take precedence over {@link #setProxyAddress(SocketAddress)} and {@link #setProxyType(Proxy.Type)}.

Configuration properties for ServiceHttpClientConfiguration

PropertyTypeDescription
micronaut.http.services.*.http-versionHttpVersionSets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.
micronaut.http.services.*.log-levelLogLevelSets the level to enable trace logging at. Depending on the implementation this may activate additional handlers. For example in Netty this will activate {@code LoggingHandler} at the given level.
micronaut.http.services.*.event-loop-groupjava.lang.StringSets the event loop group to use for the client.
micronaut.http.services.*.exception-on-error-statusbooleanSets whether throwing an exception upon HTTP error status (>= 400) is preferred. Default value ( DEFAULT_EXCEPTION_ON_ERROR_STATUS )
micronaut.http.services.*.logger-namejava.lang.StringSets the client-specific logger name.
micronaut.http.services.*.follow-redirectsbooleanSets whether redirects should be followed. Default value ( DEFAULT_FOLLOW_REDIRECTS ).
micronaut.http.services.*.default-charsetjava.nio.charset.CharsetSets the default charset to use. Default value (UTF-8);
micronaut.http.services.*.channel-optionsjava.util.MapThe Client channel options
micronaut.http.services.*.shutdown-quiet-periodjava.time.DurationSets the amount of quiet period for shutdown of client thread pools. Default value (1 milliseconds). If a task is submitted during the quiet period, it will be accepted and the quiet period will start over.
micronaut.http.services.*.shutdown-timeoutjava.time.DurationSets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).
micronaut.http.services.*.read-timeoutjava.time.DurationSets the read timeout. Default value (10 seconds).
micronaut.http.services.*.read-idle-timeoutjava.time.DurationSets the max read idle time for streaming requests. Default value (5 minutes).
micronaut.http.services.*.connection-pool-idle-timeoutjava.time.DurationSets the idle timeout for connection in the client connection pool. Defaults to 0.
micronaut.http.services.*.connect-timeoutjava.time.DurationSets the connect timeout.
micronaut.http.services.*.connect-ttljava.time.DurationSets the connect timeout.
micronaut.http.services.*.num-of-threadsjava.lang.IntegerSets the number of threads the client should use for requests.
micronaut.http.services.*.thread-factoryjava.lang.ClassSets a thread factory.
micronaut.http.services.*.max-content-lengthintSets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).
micronaut.http.services.*.proxy-typejava.net.Proxy$TypeThe proxy type
micronaut.http.services.*.proxy-addressjava.net.SocketAddressSets a proxy address.
micronaut.http.services.*.proxy-usernamejava.lang.StringSets the proxy user name to use.
micronaut.http.services.*.proxy-passwordjava.lang.StringSets the proxy password.
micronaut.http.services.*.proxy-selectorjava.net.ProxySelectorSets the proxy selector. ProxySelector decides what proxy to use and take precedence over {@link #setProxyAddress(SocketAddress)} and {@link #setProxyType(Proxy.Type)}.
micronaut.http.services.*.urlsjava.util.ListSets the URIs of the service.
micronaut.http.services.*.health-check-urijava.lang.StringSets the health check URI. Default value ("/health").
micronaut.http.services.*.health-checkbooleanSets whether the service health should be checked. Default value (false).
micronaut.http.services.*.health-check-intervaljava.time.DurationSets the default duration to check health status. Default value (30 seconds).
micronaut.http.services.*.pathjava.lang.StringSets the context path to use for requests.
micronaut.http.services.*.urljava.net.URISets the URL of the service.

Configuration properties for DefaultTrustStoreConfiguration

PropertyTypeDescription
micronaut.http.services.*.ssl.trust-storeSslConfiguration$TrustStoreConfiguration
micronaut.http.services.*.ssl.trust-store.pathjava.lang.String
micronaut.http.services.*.ssl.trust-store.passwordjava.lang.String
micronaut.http.services.*.ssl.trust-store.typejava.lang.String
micronaut.http.services.*.ssl.trust-store.providerjava.lang.String

Configuration properties for ServiceConnectionPoolConfiguration

PropertyTypeDescription
micronaut.http.services.*.pool.enabledbooleanSets whether connection pooling is enabled. Default value (false).
micronaut.http.services.*.pool.max-connectionsintSets the maximum number of connections. Defaults to no maximum.
micronaut.http.services.*.pool.max-pending-acquiresintSets the max pending acquires.
micronaut.http.services.*.pool.acquire-timeoutjava.time.DurationSets the timeout to wait for a connection.

Configuration properties for NamedClientVersioningConfiguration

PropertyTypeDescription
micronaut.http.client.versioning.*.headersjava.util.ListThe list of request header names.
micronaut.http.client.versioning.*.parametersjava.util.ListThe list of request query parameter names.

Configuration properties for DefaultKeyConfiguration

PropertyTypeDescription
micronaut.http.services.*.ssl.keySslConfiguration$KeyConfiguration
micronaut.http.services.*.ssl.key.passwordjava.lang.String
micronaut.http.services.*.ssl.key.aliasjava.lang.String

Configuration properties for ServiceSslClientConfiguration

PropertyTypeDescription
micronaut.http.services.*.ssl-configurationSslConfigurationSets the SSL configuration for the client.
micronaut.http.services.*.ssl.portint
micronaut.http.services.*.ssl.build-self-signedboolean
micronaut.http.services.*.ssl.enabledboolean
micronaut.http.services.*.ssl.client-authenticationClientAuthentication
micronaut.http.services.*.ssl.ciphersjava.lang.String
micronaut.http.services.*.ssl.protocolsjava.lang.String
micronaut.http.services.*.ssl.protocoljava.lang.String
micronaut.http.services.*.ssl.handshake-timeoutjava.time.Duration
micronaut.http.services.*.ssl.insecure-trust-all-certificatesboolean

Http Config Properties

Configuration properties for DefaultKeyStoreConfiguration

PropertyTypeDescription
micronaut.server.ssl.key-storeSslConfiguration$KeyStoreConfigurationSets the keystore configuration.
micronaut.server.ssl.key-store.pathjava.lang.StringSets the path.
micronaut.server.ssl.key-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.server.ssl.key-store.typejava.lang.StringSets the type of keystore.
micronaut.server.ssl.key-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for DefaultSslConfiguration

PropertyTypeDescription
micronaut.ssl.portintSets the SSL port. Default value (8443).
micronaut.ssl.build-self-signedbooleanSets whether to build a self signed certificate. Default value (false).
micronaut.ssl.enabledbooleanWhether SSL is enabled. Default value (false).
micronaut.ssl.client-authenticationClientAuthenticationSets the client authentication mode.
micronaut.ssl.ciphersjava.lang.StringSets the ciphers to use.
micronaut.ssl.protocolsjava.lang.StringSets the protocols to use.
micronaut.ssl.protocoljava.lang.StringSets the protocol to use. Default value ("TLS").
micronaut.ssl.handshake-timeoutjava.time.DurationThe timeout for the SSL handshake

Configuration properties for DefaultKeyConfiguration

PropertyTypeDescription
micronaut.ssl.keySslConfiguration$KeyConfigurationSets the key configuration.
micronaut.ssl.key.passwordjava.lang.StringSets the password.
micronaut.ssl.key.aliasjava.lang.StringSets the alias.

Configuration properties for DefaultTrustStoreConfiguration

PropertyTypeDescription
micronaut.http.client.ssl.trust-storeSslConfiguration$TrustStoreConfigurationSets the trust store configuration.
micronaut.http.client.ssl.trust-store.pathjava.lang.StringSets the path.
micronaut.http.client.ssl.trust-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.http.client.ssl.trust-store.typejava.lang.StringSets the type of keystore.
micronaut.http.client.ssl.trust-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for ServerSslConfiguration

PropertyTypeDescription
micronaut.server.ssl.portintSets the SSL port. Default value (8443).
micronaut.server.ssl.build-self-signedbooleanSets whether to build a self signed certificate. Default value (false).
micronaut.server.ssl.enabledbooleanWhether SSL is enabled. Default value (false).
micronaut.server.ssl.client-authenticationClientAuthenticationSets the client authentication mode.
micronaut.server.ssl.ciphersjava.lang.StringSets the ciphers to use.
micronaut.server.ssl.protocolsjava.lang.StringSets the protocols to use.
micronaut.server.ssl.protocoljava.lang.StringSets the protocol to use. Default value ("TLS").
micronaut.server.ssl.handshake-timeoutjava.time.DurationThe timeout for the SSL handshake

Configuration properties for DefaultKeyStoreConfiguration

PropertyTypeDescription
micronaut.http.client.ssl.key-storeSslConfiguration$KeyStoreConfigurationSets the keystore configuration.
micronaut.http.client.ssl.key-store.pathjava.lang.StringSets the path.
micronaut.http.client.ssl.key-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.http.client.ssl.key-store.typejava.lang.StringSets the type of keystore.
micronaut.http.client.ssl.key-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for DefaultTrustStoreConfiguration

PropertyTypeDescription
micronaut.ssl.trust-storeSslConfiguration$TrustStoreConfigurationSets the trust store configuration.
micronaut.ssl.trust-store.pathjava.lang.StringSets the path.
micronaut.ssl.trust-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.ssl.trust-store.typejava.lang.StringSets the type of keystore.
micronaut.ssl.trust-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for DefaultKeyStoreConfiguration

PropertyTypeDescription
micronaut.ssl.key-storeSslConfiguration$KeyStoreConfigurationSets the keystore configuration.
micronaut.ssl.key-store.pathjava.lang.StringSets the path.
micronaut.ssl.key-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.ssl.key-store.typejava.lang.StringSets the type of keystore.
micronaut.ssl.key-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for DefaultKeyConfiguration

PropertyTypeDescription
micronaut.server.ssl.keySslConfiguration$KeyConfigurationSets the key configuration.
micronaut.server.ssl.key.passwordjava.lang.StringSets the password.
micronaut.server.ssl.key.aliasjava.lang.StringSets the alias.

Configuration properties for ClientSslConfiguration

PropertyTypeDescription
micronaut.http.client.ssl.portintSets the SSL port. Default value (8443).
micronaut.http.client.ssl.build-self-signedbooleanSets whether to build a self signed certificate. Default value (false).
micronaut.http.client.ssl.enabledbooleanWhether SSL is enabled. Default value (false).
micronaut.http.client.ssl.client-authenticationClientAuthenticationSets the client authentication mode.
micronaut.http.client.ssl.ciphersjava.lang.StringSets the ciphers to use.
micronaut.http.client.ssl.protocolsjava.lang.StringSets the protocols to use.
micronaut.http.client.ssl.protocoljava.lang.StringSets the protocol to use. Default value ("TLS").
micronaut.http.client.ssl.handshake-timeoutjava.time.DurationThe timeout for the SSL handshake
micronaut.http.client.ssl.insecure-trust-all-certificatesbooleanWhether the client should disable checking of the remote SSL certificate.

Configuration properties for DefaultKeyConfiguration

PropertyTypeDescription
micronaut.http.client.ssl.keySslConfiguration$KeyConfigurationSets the key configuration.
micronaut.http.client.ssl.key.passwordjava.lang.StringSets the password.
micronaut.http.client.ssl.key.aliasjava.lang.StringSets the alias.

Configuration properties for DefaultTrustStoreConfiguration

PropertyTypeDescription
micronaut.server.ssl.trust-storeSslConfiguration$TrustStoreConfigurationSets the trust store configuration.
micronaut.server.ssl.trust-store.pathjava.lang.StringSets the path.
micronaut.server.ssl.trust-store.passwordjava.lang.StringSets the password to use for the keystore.
micronaut.server.ssl.trust-store.typejava.lang.StringSets the type of keystore.
micronaut.server.ssl.trust-store.providerjava.lang.StringSets the keystore provider name.

Configuration properties for CodecConfiguration

PropertyTypeDescription
micronaut.codec.*.additional-typesjava.util.ListDefault value (Empty list).

Http Netty Config Properties

Configuration properties for DefaultEventLoopGroupConfiguration

PropertyTypeDescription
micronaut.netty.event-loops.*.num-threadsint
micronaut.netty.event-loops.*.io-ratiojava.lang.Integer
micronaut.netty.event-loops.*.prefer-native-transportboolean
micronaut.netty.event-loops.*.executorjava.lang.String
micronaut.netty.event-loops.*.shutdown-quiet-periodjava.time.Duration
micronaut.netty.event-loops.*.shutdown-timeoutjava.time.Duration

Configuration properties for NettyGlobalConfiguration

PropertyTypeDescription
netty.resource-leak-detector-levelio.netty.util.ResourceLeakDetector$LevelSets the resource leak detection level.

Http Server Config Properties

Configuration properties for HttpServerConfiguration

PropertyTypeDescription
micronaut.server.portjava.lang.IntegerSets the port to bind to. Default value (-1)
micronaut.server.hostjava.lang.StringSets the host to bind to.
micronaut.server.read-timeoutjava.lang.IntegerSets the default read timeout.
micronaut.server.max-request-sizelongSets the maximum request size. Default value (1024 * 1024 * 10L ⇒ // 10MB)
micronaut.server.read-idle-timeoutjava.time.DurationSets the amount of time a connection can remain idle without any reads occurring. Default value (5L minutes).
micronaut.server.write-idle-timeoutjava.time.DurationSets the amount of time a connection can remain idle without any writes occurring. Default value (5L minutes).
micronaut.server.idle-timeoutjava.time.DurationSets the idle time of connections for the server. Default value (5 minutes).
micronaut.server.server-headerjava.lang.StringSets the name of the server header.
micronaut.server.date-headerbooleanSets whether a date header should be sent back. Default value (true).
micronaut.server.log-handled-exceptionsbooleanSets whether exceptions handled by either an error route or exception handler should still be logged. Default value (false).
micronaut.server.client-address-headerjava.lang.StringThe header that stores the original client address
micronaut.server.context-pathjava.lang.StringSets the context path for the web server.
micronaut.server.dual-protocolbooleanthe dual protocol (http/https) configuration. Default value (false).
micronaut.server.http-to-https-redirectbooleanSet to true to enable redirecting all http requests to the same URL but with
micronaut.server.http-versionHttpVersionSets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.
micronaut.server.default-charsetjava.nio.charset.CharsetThe default charset to use
micronaut.server.thread-selectionThreadSelectionSets the {@link ThreadSelection} model to use for the server.

Configuration properties for HostResolutionConfiguration

PropertyTypeDescription
micronaut.server.host-resolutionHttpServerConfiguration$HostResolutionConfigurationThe host resolution configuration
micronaut.server.host-resolution.host-headerjava.lang.StringThe header name that stores the host
micronaut.server.host-resolution.protocol-headerjava.lang.StringThe header name that stores the protocol
micronaut.server.host-resolution.port-headerjava.lang.StringThe header name that stores the port
micronaut.server.host-resolution.port-in-hostbooleanTrue if the host header supports a port
micronaut.server.host-resolution.allowed-hostsjava.util.ListThe list of allowed host regex patterns. Any resolved

Configuration properties for CorsConfiguration

PropertyTypeDescription
micronaut.server.corsHttpServerConfiguration$CorsConfigurationSets the cors configuration.
micronaut.server.cors.enabledbooleanSets whether CORS is enabled. Default value (false)
micronaut.server.cors.single-headerbooleanSets whether CORS header values should be joined into a single header. Default value (false).
micronaut.server.cors.configurationsjava.util.MapSets the CORS configurations.

Configuration properties for HttpLocaleResolutionConfigurationProperties

PropertyTypeDescription
micronaut.server.locale-resolutionHttpServerConfiguration$HttpLocaleResolutionConfigurationPropertiesThe locale resolution configuration
micronaut.server.locale-resolution.fixedjava.util.LocaleSet the language tag for the locale. Supports BCP 47 language tags (e.g. "en-US") and ISO standard (e.g "en_US").
micronaut.server.locale-resolution.session-attributejava.lang.StringSets the key in the session to look for the locale.
micronaut.server.locale-resolution.cookie-namejava.lang.StringSets the name of the cookie that is used to store the locale.
micronaut.server.locale-resolution.headerbooleanSet to true if the locale should be resolved from the Accept-Language header. Default value (true).
micronaut.server.locale-resolution.default-localejava.util.LocaleSets the locale that will be used if the locale cannot be resolved through any means. Defaults to the system default.

Configuration properties for MultipartConfiguration

PropertyTypeDescription
micronaut.server.multipart.locationjava.io.FileSets the location to store files.
micronaut.server.multipart.max-file-sizelongSets the max file size. Default value (1024L * 1024 ⇒ 1MB).
micronaut.server.multipart.enabledjava.lang.BooleanSets whether multipart processing is enabled. Default value (false).
micronaut.server.multipart.diskbooleanSets whether to buffer data to disk or not. Default value (false).
micronaut.server.multipart.mixedbooleanSets whether to buffer data to disk if the size is greater than the threshold. Default value (false).
micronaut.server.multipart.thresholdlongSets the amount of data that should be received that will trigger the data to be stored to disk. Default value (1024L * 1024 * 10).
micronaut.server.multipartHttpServerConfiguration$MultipartConfigurationSets the multipart configuration.

Http Server Netty Config Properties

Configuration properties for Http2Settings

PropertyTypeDescription
micronaut.server.netty.http2NettyHttpServerConfiguration$Http2SettingsSets the Http2Settings.
micronaut.server.netty.http2.header-table-sizejava.lang.LongSets the {@code SETTINGS_HEADER_TABLE_SIZE} value.
micronaut.server.netty.http2.push-enabledjava.lang.BooleanSets the {@code SETTINGS_ENABLE_PUSH} value.
micronaut.server.netty.http2.max-concurrent-streamsjava.lang.LongSets the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value.
micronaut.server.netty.http2.initial-window-sizejava.lang.IntegerSets the {@code SETTINGS_INITIAL_WINDOW_SIZE} value.
micronaut.server.netty.http2.max-frame-sizejava.lang.IntegerSets the {@code SETTINGS_MAX_FRAME_SIZE} value.
micronaut.server.netty.http2.max-header-list-sizejava.lang.LongSets the {@code SETTINGS_MAX_HEADER_LIST_SIZE} value.

Configuration properties for AccessLogger

PropertyTypeDescription
micronaut.server.netty.access-loggerNettyHttpServerConfiguration$AccessLoggerSets the AccessLogger configuration.
micronaut.server.netty.access-logger.enabledbooleanEnables or Disables the access logger.
micronaut.server.netty.access-logger.logger-namejava.lang.StringSets the logger name to use. If not specified 'HTTP_ACCESS_LOGGER' will be used.
micronaut.server.netty.access-logger.log-formatjava.lang.StringSets the log format to use. When not specified, the Common Log Format (CLF) will be used.
micronaut.server.netty.access-logger.exclusionsjava.util.ListSets the URI patterns to be excluded from the access log.

Configuration properties for Worker

PropertyTypeDescription
micronaut.server.netty.workerNettyHttpServerConfiguration$WorkerSets the worker event loop configuration.
micronaut.server.netty.worker.event-loop-groupjava.lang.StringSets the name to use.
micronaut.server.netty.worker.threadsintSets the number of threads for the event loop group.
micronaut.server.netty.worker.io-ratiojava.lang.IntegerSets the I/O ratio.
micronaut.server.netty.worker.executorjava.lang.StringSets the name of the executor.
micronaut.server.netty.worker.prefer-native-transportbooleanSet whether to prefer the native transport if available
micronaut.server.netty.worker.shutdown-quiet-periodjava.time.DurationSet the shutdown quiet period
micronaut.server.netty.worker.shutdown-timeoutjava.time.DurationSet the shutdown timeout (must be >= shutdownQuietPeriod)

Configuration properties for CacheControlConfiguration

PropertyTypeDescription
micronaut.server.netty.responses.file.cache-controlNettyHttpServerConfiguration$FileTypeHandlerConfiguration$CacheControlConfigurationSets the cache control configuration.
micronaut.server.netty.responses.file.cache-control.publicbooleanSets whether the cache control is public. Default value (false)

Configuration properties for FileTypeHandlerConfiguration

PropertyTypeDescription
micronaut.server.netty.responses.file.cache-secondsintCache Seconds. Default value (60).

Configuration properties for CacheControlConfiguration

PropertyTypeDescription
netty.responses.file.cache-controlFileTypeHandlerConfiguration$CacheControlConfigurationSets the cache control configuration.
netty.responses.file.cache-control.publicbooleanSets whether the cache control is public. Default value (false)

Configuration properties for NettyHttpServerConfiguration

PropertyTypeDescription
micronaut.server.netty.child-optionsjava.util.MapSets the Netty child worker options.
micronaut.server.netty.optionsjava.util.MapSets the channel options.
micronaut.server.netty.max-initial-line-lengthintSets the maximum initial line length for the HTTP request. Default value (4096).
micronaut.server.netty.max-header-sizeintSets the maximum size of any one header. Default value (8192).
micronaut.server.netty.max-chunk-sizeintSets the maximum size of any single request chunk. Default value (8192).
micronaut.server.netty.max-h2c-upgrade-request-sizeintSets 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-supportedbooleanSets whether chunked transfer encoding is supported. Default value (true).
micronaut.server.netty.validate-headersbooleanSets whether to validate incoming headers. Default value (true).
micronaut.server.netty.initial-buffer-sizeintSets the initial buffer size. Default value (128).
micronaut.server.netty.log-levelio.netty.handler.logging.LogLevelSets the Netty log level.
micronaut.server.netty.compression-thresholdintSets the minimum size of a request body must be in order to be compressed. Default value (1024).
micronaut.server.netty.compression-levelintSets the compression level (0-9). Default value (6).
micronaut.server.netty.use-native-transportbooleanSets whether to use netty’s native transport (epoll or kqueue) if available . Default value (false).
micronaut.server.netty.fallback-protocoljava.lang.StringSets the fallback protocol to use when negotiating via ALPN.
micronaut.server.netty.keep-alive-on-server-errorbooleanWhether to send connection keep alive on internal server errors. Default value ({@value DEFAULT_KEEP_ALIVE_ON_SERVER_ERROR}).
micronaut.server.netty.pcap-logging-path-patternjava.lang.StringThe 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!

Configuration properties for Parent

PropertyTypeDescription
micronaut.server.netty.parent.event-loop-groupjava.lang.StringSets the name to use.
micronaut.server.netty.parent.threadsintSets the number of threads for the event loop group.
micronaut.server.netty.parent.io-ratiojava.lang.IntegerSets the I/O ratio.
micronaut.server.netty.parent.executorjava.lang.StringSets the name of the executor.
micronaut.server.netty.parent.prefer-native-transportbooleanSet whether to prefer the native transport if available
micronaut.server.netty.parent.shutdown-quiet-periodjava.time.DurationSet the shutdown quiet period
micronaut.server.netty.parent.shutdown-timeoutjava.time.DurationSet the shutdown timeout (must be >= shutdownQuietPeriod)
micronaut.server.netty.parentNettyHttpServerConfiguration$ParentSets the parent event loop configuration.

Configuration properties for FileTypeHandlerConfiguration

PropertyTypeDescription
netty.responses.file.cache-secondsintCache Seconds. Default value (60).

Jackson Databind Config Properties

Configuration properties for JacksonConfiguration

PropertyTypeDescription
jackson.module-scanbooleanSets whether to scan for modules or not (defaults to true).
jackson.bean-introspection-modulebooleanWhether the BeanIntrospection should be used for reflection free object serialialization/deserialialization.
jackson.date-formatjava.lang.StringSets the default date format to use.
jackson.localejava.util.LocaleSets the locale to use.
jackson.time-zonejava.util.TimeZoneSets the timezone to use.
jackson.array-size-thresholdintSets the array size threshold for data binding. Default value (100).
jackson.serializationjava.util.MapSets the serialization features to use.
jackson.deserializationjava.util.MapSets the deserialization features to use.
jackson.mapperjava.util.MapSets the object mapper features to use.
jackson.parserjava.util.MapSets the parser features to use.
jackson.generatorjava.util.MapSets the generator features to use.
jackson.factoryjava.util.MapSets the factory features to use.
jackson.serialization-inclusioncom.fasterxml.jackson.annotation.JsonInclude$IncludeSets the serialization inclusion mode.
jackson.default-typingcom.fasterxml.jackson.databind.ObjectMapper$DefaultTypingSets the global defaultTyping using for Polymorphic handling.
jackson.property-naming-strategycom.fasterxml.jackson.databind.PropertyNamingStrategySets the property naming strategy.
jackson.always-serialize-errors-as-listbooleanSets whether _embedded.errors should always be serialized as list (defaults to false). If set to false, _embedded.errors with 1 element will be serialized as an object.
jackson.trim-stringsbooleanWhether strings should be trimmed when deserializing (defaults to false). If the resulting string is an empty string, then null will be applied instead.

Management Config Properties

Configuration properties for EndpointConfiguration

PropertyTypeDescription
endpoints.*.enabledjava.lang.BooleanSets whether the endpoint is enabled.
endpoints.*.sensitivejava.lang.BooleanSets whether the endpoint is sensitive.

Configuration properties for DiskSpaceIndicatorConfiguration

PropertyTypeDescription
endpoints.health.disk-space.enabledbooleanDefault value (true).
endpoints.health.disk-space.pathjava.io.FileDefault value (".").
endpoints.health.disk-space.thresholdlongDefault value (1024L * 1024 * 10 ⇒ 10MB).

Configuration properties for EndpointDefaultConfiguration

PropertyTypeDescription
endpoints.all.enabledjava.lang.BooleanSets whether the endpoint is enabled.
endpoints.all.sensitivejava.lang.BooleanSets whether the endpoint is sensitive.
endpoints.all.portjava.lang.IntegerSets the port to expose endpoints via.
endpoints.all.pathjava.lang.StringThe endpoints base path. Default value ("/").

Configuration properties for LoggersEndpoint

PropertyTypeDescription
endpoints.loggers.write-sensitivebooleanDetermines whether modifications to the log level should require authentication. Default value (true).

Configuration properties for StatusConfiguration

PropertyTypeDescription
endpoints.health.status.http-mappingjava.util.MapSet how HealthStatus map to HttpStatus codes.

Configuration properties for HealthEndpoint

PropertyTypeDescription
endpoints.health.details-visibleDetailsVisibilitySets the visibility policy for health information.

Configuration properties for DiscoveryClientHealthIndicatorConfiguration

PropertyTypeDescription
endpoints.health.discovery-client.enabledbooleanIf health indicator should be enabled. Default is true.

Router Config Properties

Configuration properties for HeaderVersionResolverConfiguration

PropertyTypeDescription
micronaut.router.versioning.header.enabledbooleanSets whether headers should be searched for a version.
micronaut.router.versioning.header.namesjava.util.ListSets which headers should be searched for a version.

Configuration properties for StaticResourceConfiguration

PropertyTypeDescription
micronaut.router.static-resources.*.enabledbooleanSets whether this specific mapping is enabled. Default value (true).
micronaut.router.static-resources.*.pathsjava.util.ListA 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.
micronaut.router.static-resources.*.mappingjava.lang.StringThe path resources should be served from. Uses ant path matching. Default value ("/**").

Configuration properties for RoutesVersioningConfiguration

PropertyTypeDescription
micronaut.router.versioning.enabledbooleanEnables the version based route matches filtering.
micronaut.router.versioning.default-versionjava.lang.StringSets the version to use if the version cannot be resolved. Default value (null).

Configuration properties for ParameterVersionResolverConfiguration

PropertyTypeDescription
micronaut.router.versioning.parameter.enabledbooleanSets whether parameter should be searched for a version.
micronaut.router.versioning.parameter.namesjava.util.ListSets which parameter should be searched for a version.

Runtime Config Properties

Configuration properties for HeartbeatConfiguration

PropertyTypeDescription
micronaut.heartbeat.intervaljava.time.DurationDefault value (15 seconds).
micronaut.heartbeat.enabledbooleanDefault value (true).

Configuration properties for DigitalOceanMetadataConfiguration

PropertyTypeDescription
micronaut.application.digitalocean.metadata.urljava.lang.StringDefault value ("http://169.254.169.254/metadata/v1.json").
micronaut.application.digitalocean.metadata.enabledbooleanDefault value (true).

Session Config Properties

Configuration properties for HttpSessionConfiguration

PropertyTypeDescription
micronaut.session.http.remember-mebooleanDefault value (false).
micronaut.session.http.base64-encodebooleanDefault value (true).
micronaut.session.http.cookie-max-agejava.time.temporal.TemporalAmountSets the maximum age of the cookie.
micronaut.session.http.cookie-securejava.lang.BooleanSets the secure status of the cookie. Delegates to http if not set.
micronaut.session.http.cookie-pathjava.lang.StringSet the cookie path to use. Default value ("/").
micronaut.session.http.domain-namejava.lang.StringSet the domain name to use for the cookie
micronaut.session.http.cookie-namejava.lang.StringDefault value ("SESSION").
micronaut.session.http.prefixjava.lang.StringSet the prefix to use when serializing session ID
micronaut.session.http.header-namesjava.lang.String[]Default values ([{@value io.micronaut.http.HttpHeaders#AUTHORIZATION_INFO}, {@value io.micronaut.http.HttpHeaders#X_AUTH_TOKEN}]).
micronaut.session.http.cookie-domainjava.lang.StringSet the domain name to use for the cookie
micronaut.session.http.cookie-same-siteSameSiteDetermines if this this Cookie can be sent along cross-site requests. For more information, please look <a href="https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-05">here</a>

Configuration properties for SessionConfiguration

PropertyTypeDescription
micronaut.session.max-inactive-intervaljava.time.DurationSet the maximum inactive interval. Default value (30 minutes).
micronaut.session.max-active-sessionsjava.lang.IntegerSets the maximum number of active sessions.
micronaut.session.prompt-expirationbooleanSet if prompt expiration is enabled.
micronaut.session.executor-serviceBeanProviderSet the executor service.

Validation Config Properties

Configuration properties for DefaultValidatorConfiguration

PropertyTypeDescription
micronaut.validator.enabledbooleanSets whether Micronaut’s validator is enabled.