ManagementRoutesOptionsType

このコンテンツはまだ日本語訳がありません。

ManagementRoutesOptionsType = object

Plain options-object shape accepted by the management routes factory.

Properties

readonly optional auth?: Middleware

Auth middleware for the privileged subset of management routes.

readonly optional authProtectHealth?: boolean

Also apply auth to /health and /ready. Default: false.

readonly optional enableDownEndpoint?: boolean

Allow POST /cluster/down — operator-initiated force-down. Off by default.

readonly optional enableLeaveEndpoint?: boolean

Allow POST /cluster/leave (requires cluster).

readonly optional enableMetricsEndpoint?: boolean

Expose GET /metrics in Prometheus text format. Off by default.

readonly optional ipAllowlist?: Middleware

IP-allowlist middleware applied to every management endpoint (incl. health).