AdminConfig

data class AdminConfig(val enabled: Boolean, val port: Int, val pingPath: String, val versionPath: String, val healthCheckPath: String, val threadDumpPath: String, val host: String? = null)

Configuration data for administrative HTTP endpoints exposed by GenericService and GenericKtorService.

Controls whether the admin servlet group is enabled and defines the port, bind address, and URL paths for standard operational endpoints (ping, version, health check, thread dump). Paths may be given with or without a leading slash.

Constructors

Link copied to clipboard
constructor(enabled: Boolean, port: Int, pingPath: String, versionPath: String, healthCheckPath: String, threadDumpPath: String, host: String? = null)

Properties

Link copied to clipboard

Whether the admin endpoints are enabled.

Link copied to clipboard

The URL path for the health check endpoint.

Link copied to clipboard
val host: String?

The interface the admin server binds to, such as "127.0.0.1" to accept only local connections. The default, null, binds every interface.

Link copied to clipboard

The URL path for the ping (liveness) endpoint.

Link copied to clipboard
val port: Int

The HTTP port on which admin servlets are served.

Link copied to clipboard

The URL path for the thread dump endpoint.

Link copied to clipboard

The URL path for the version information endpoint.