News

New Laravel 11 Apps Include a Health Check Endpoint

Published Updated
New Laravel 11 Apps Include a Health Check Endpoint image

As part of the release of Laravel 11, new applications include a health /up endpoint. This route is defined in the new bootstrap/app.php file by passing the health parameter—which is defined by default in the Laravel 11 skeleton:

Application::configure(basePath: dirname(__DIR__))
->withProviders()
->withRouting(
web: __DIR__.'/../routes/web.php',
// api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
// channels: __DIR__.'/../routes/channels.php',
+ health: '/up',
)
// ...

When setting up the application routing, the Laravel framework defines the health route and also emits a DiagnosingHealth event:

use Illuminate\Foundation\Events\DiagnosingHealth;
 
// ...
 
if (is_string($health)) {
Route::middleware('web')->get($health, function () {
Event::dispatch(new DiagnosingHealth);
 
return View::file(__DIR__.'/../resources/health-up.blade.php');
});
}

The route is configurable with the default /up endpoint and returns an animated “Application up” health page in the browser:

Laravel 11 health page
The Laravel 11 health page
Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

masteringlaravel logo
Laravel Code Review

Get expert guidance in a few days with a Laravel code review

Visit Laravel Code Review

The latest

View all →
Volker Dusch on the PHP RCE Vulnerabilities and Disclosure image

Volker Dusch on the PHP RCE Vulnerabilities and Disclosure

Read article
Decide with Jev: Turn AI Answers into Decisions with PHP Rules image

Decide with Jev: Turn AI Answers into Decisions with PHP Rules

Read article
Skuul: Open-Source School Management Built on Laravel image

Skuul: Open-Source School Management Built on Laravel

Read article
Laravel Read Replicas: Prevent Stale Reads After a Write image

Laravel Read Replicas: Prevent Stale Reads After a Write

Read article
Screenshot: Capture Images and PDFs with PHP and Laravel image

Screenshot: Capture Images and PDFs with PHP and Laravel

Read article
Reset Sticky Database Connections Between Laravel Queue Jobs image

Reset Sticky Database Connections Between Laravel Queue Jobs

Read article