Skip to contents

Configure health check endpoint

Usage

payload_health_config(enabled = TRUE, path = "/health")

Arguments

enabled

Enable or disable health check endpoint (default TRUE)

path

URL path for health check (default "/health")

Value

Invisibly returns TRUE, called for side effects

Examples

if (interactive()) {
  # Use custom health check path
  payload_health_config(enabled = TRUE, path = "/api/health")

  # Disable health checks
  payload_health_config(enabled = FALSE)
}