Health Probes

Use .NET health probe endpoints to monitor whether your Umbraco application is alive and ready to serve requests.

.NET includes a built-in health checks middleware that exposes HTTP endpoints reporting whether an application is alive and functioning. Orchestrators, load balancers, and monitoring tools poll these endpoints to decide if an instance should receive traffic.

These endpoints are infrastructure-level HTTP probes used by orchestrators and load balancers. They are different from the Health Check dashboard in the backoffice, which validates Umbraco and website-specific best practices.

Overview

Umbraco builds on this middleware and exposes two health probe endpoints that reflect the current runtime state. These endpoints are available in Umbraco 17.3 and later.

Endpoints

Endpoint

Behavior

GET /umbraco/api/health/live

Returns HTTP 200 if the process is responding. No checks run.

GET /umbraco/api/health/ready

Returns HTTP 200 when the site is running normally. Returns HTTP 503 when the site is not ready, for example, during startup or an unattended upgrade.

Both endpoints are anonymous and bypass the maintenance-page re-route active during upgrades.

Configuring health probes

Use the endpoints above to configure liveness and readiness probes on your hosting platform.

Examples for some common hosting environments are shown below.

In the Azure Portal, navigate to your App Service and open Monitoring > Health check. Set the path to:

/umbraco/api/health/ready

Azure uses this path to determine whether the instance is healthy and should receive traffic.

livenessProbe:
  httpGet:
    path: /umbraco/api/health/live
    port: 8080
  initialDelaySeconds: 5
  periodSeconds: 10
readinessProbe:
  httpGet:
    path: /umbraco/api/health/ready
    port: 8080
  initialDelaySeconds: 5
  periodSeconds: 10

services:
  umbraco:
    image: my-umbraco-app
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/umbraco/api/health/ready"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 30s

PreviousRunning Umbraco in Docker NextUmbraco in Load Balanced Environments

Last updated 12 hours ago

Was this helpful?

Good evening

hashtagOverview

hashtagEndpoints

hashtagConfiguring health probes

hashtagRelated

Overview

Endpoints

Configuring health probes

Related